diff options
Diffstat (limited to 'man/fido_bio_dev_get_info.3')
-rw-r--r-- | man/fido_bio_dev_get_info.3 | 120 |
1 files changed, 120 insertions, 0 deletions
diff --git a/man/fido_bio_dev_get_info.3 b/man/fido_bio_dev_get_info.3 new file mode 100644 index 0000000..bde1396 --- /dev/null +++ b/man/fido_bio_dev_get_info.3 | |||
@@ -0,0 +1,120 @@ | |||
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_DEV_GET_INFO 3 | ||
7 | .Os | ||
8 | .Sh NAME | ||
9 | .Nm fido_bio_dev_get_info , | ||
10 | .Nm fido_bio_dev_enroll_begin , | ||
11 | .Nm fido_bio_dev_enroll_continue , | ||
12 | .Nm fido_bio_dev_enroll_cancel , | ||
13 | .Nm fido_bio_dev_enroll_remove , | ||
14 | .Nm fido_bio_dev_get_template_array , | ||
15 | .Nm fido_bio_dev_set_template_name | ||
16 | .Nd FIDO 2 biometric authenticator API | ||
17 | .Sh SYNOPSIS | ||
18 | .In fido.h | ||
19 | .In fido/bio.h | ||
20 | .Ft int | ||
21 | .Fn fido_bio_dev_get_info "fido_dev_t *dev" "fido_bio_info_t *info" | ||
22 | .Ft int | ||
23 | .Fn fido_bio_dev_enroll_begin "fido_dev_t *dev" "fido_bio_template_t *template" "fido_bio_enroll_t *enroll" "uint32_t timeout_ms" "const char *pin" | ||
24 | .Ft int | ||
25 | .Fn fido_bio_dev_enroll_continue "fido_dev_t *dev" "const fido_bio_template_t *template" "fido_bio_enroll_t *enroll" "uint32_t timeout_ms" | ||
26 | .Ft int | ||
27 | .Fn fido_bio_dev_enroll_cancel "fido_dev_t *dev" | ||
28 | .Ft int | ||
29 | .Fn fido_bio_dev_enroll_remove "fido_dev_t *dev" "const fido_bio_template_t *template" "const char *pin" | ||
30 | .Ft int | ||
31 | .Fn fido_bio_dev_get_template_array "fido_dev_t *dev" "fido_bio_template_array_t *template_array" "const char *pin" | ||
32 | .Ft int | ||
33 | .Fn fido_bio_dev_set_template_name "fido_dev_t *dev" "const fido_bio_template_t *template" "const char *pin" | ||
34 | .Sh DESCRIPTION | ||
35 | The functions described in this page allow biometric | ||
36 | templates on a FIDO2 authenticator to be listed, created, | ||
37 | removed, and customised. | ||
38 | For a description of the types involved, please refer to | ||
39 | .Xr fido_bio_info_new 3 , | ||
40 | .Xr fido_bio_enroll_new 3 , | ||
41 | and | ||
42 | .Xr fido_bio_template 3 . | ||
43 | .Pp | ||
44 | The | ||
45 | .Fn fido_bio_dev_get_info | ||
46 | function populates | ||
47 | .Fa info | ||
48 | with sensor information from | ||
49 | .Fa dev . | ||
50 | .Pp | ||
51 | The | ||
52 | .Fn fido_bio_dev_enroll_begin | ||
53 | function initiates a biometric enrollment on | ||
54 | .Fa dev , | ||
55 | instructing the authenticator to wait | ||
56 | .Fa timeout_ms | ||
57 | milliseconds. | ||
58 | On success, | ||
59 | .Fa template | ||
60 | and | ||
61 | .Fa enroll | ||
62 | will be populated with the newly created template's | ||
63 | information and enrollment status, respectively. | ||
64 | .Pp | ||
65 | The | ||
66 | .Fn fido_bio_dev_enroll_continue | ||
67 | function continues an ongoing enrollment on | ||
68 | .Fa dev , | ||
69 | instructing the authenticator to wait | ||
70 | .Fa timeout_ms | ||
71 | milliseconds. | ||
72 | On success, | ||
73 | .Fa enroll | ||
74 | will be updated to reflect the status of the biometric | ||
75 | enrollment. | ||
76 | .Pp | ||
77 | The | ||
78 | .Fn fido_bio_dev_enroll_cancel | ||
79 | function cancels an ongoing enrollment on | ||
80 | .Fa dev . | ||
81 | .Pp | ||
82 | The | ||
83 | .Fn fido_bio_dev_enroll_remove | ||
84 | function removes | ||
85 | .Fa template | ||
86 | from | ||
87 | .Fa dev . | ||
88 | .Pp | ||
89 | The | ||
90 | .Fn fido_bio_dev_get_template_array | ||
91 | function populates | ||
92 | .Fa template_array | ||
93 | with the templates currently enrolled on | ||
94 | .Fa dev . | ||
95 | .Pp | ||
96 | The | ||
97 | .Fn fido_bio_dev_set_template_name | ||
98 | function sets the friendly name of | ||
99 | .Fa template | ||
100 | on | ||
101 | .Fa dev . | ||
102 | .Pp | ||
103 | The error codes returned by | ||
104 | .Fn fido_bio_dev_get_info , | ||
105 | .Fn fido_bio_dev_enroll_begin , | ||
106 | .Fn fido_bio_dev_enroll_continue , | ||
107 | .Fn fido_bio_dev_enroll_cancel , | ||
108 | .Fn fido_bio_dev_enroll_remove , | ||
109 | .Fn fido_bio_dev_get_template_array , | ||
110 | and | ||
111 | .Fn fido_bio_dev_set_template_name | ||
112 | are defined in | ||
113 | .In fido/err.h . | ||
114 | On success, | ||
115 | .Dv FIDO_OK | ||
116 | is returned. | ||
117 | .Sh SEE ALSO | ||
118 | .Xr fido_bio_enroll_new 3 , | ||
119 | .Xr fido_bio_info_new 3 , | ||
120 | .Xr fido_bio_template 3 | ||