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 35The functions described in this page allow biometric 36templates on a FIDO2 authenticator to be listed, created, 37removed, and customised. 38For a description of the types involved, please refer to 39.Xr fido_bio_info_new 3 , 40.Xr fido_bio_enroll_new 3 , 41and 42.Xr fido_bio_template 3 . 43.Pp 44The 45.Fn fido_bio_dev_get_info 46function populates 47.Fa info 48with sensor information from 49.Fa dev . 50.Pp 51The 52.Fn fido_bio_dev_enroll_begin 53function initiates a biometric enrollment on 54.Fa dev , 55instructing the authenticator to wait 56.Fa timeout_ms 57milliseconds. 58On success, 59.Fa template 60and 61.Fa enroll 62will be populated with the newly created template's 63information and enrollment status, respectively. 64.Pp 65The 66.Fn fido_bio_dev_enroll_continue 67function continues an ongoing enrollment on 68.Fa dev , 69instructing the authenticator to wait 70.Fa timeout_ms 71milliseconds. 72On success, 73.Fa enroll 74will be updated to reflect the status of the biometric 75enrollment. 76.Pp 77The 78.Fn fido_bio_dev_enroll_cancel 79function cancels an ongoing enrollment on 80.Fa dev . 81.Pp 82The 83.Fn fido_bio_dev_enroll_remove 84function removes 85.Fa template 86from 87.Fa dev . 88.Pp 89The 90.Fn fido_bio_dev_get_template_array 91function populates 92.Fa template_array 93with the templates currently enrolled on 94.Fa dev . 95.Pp 96The 97.Fn fido_bio_dev_set_template_name 98function sets the friendly name of 99.Fa template 100on 101.Fa dev . 102.Pp 103The 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 , 110and 111.Fn fido_bio_dev_set_template_name 112are defined in 113.In fido/err.h . 114On success, 115.Dv FIDO_OK 116is 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 121