10afa8e06SEd Maste.\" Copyright (c) 2019 Yubico AB. All rights reserved. 2*2ccfa855SEd Maste.\" 3*2ccfa855SEd Maste.\" Redistribution and use in source and binary forms, with or without 4*2ccfa855SEd Maste.\" modification, are permitted provided that the following conditions are 5*2ccfa855SEd Maste.\" met: 6*2ccfa855SEd Maste.\" 7*2ccfa855SEd Maste.\" 1. Redistributions of source code must retain the above copyright 8*2ccfa855SEd Maste.\" notice, this list of conditions and the following disclaimer. 9*2ccfa855SEd Maste.\" 2. Redistributions in binary form must reproduce the above copyright 10*2ccfa855SEd Maste.\" notice, this list of conditions and the following disclaimer in 11*2ccfa855SEd Maste.\" the documentation and/or other materials provided with the 12*2ccfa855SEd Maste.\" distribution. 13*2ccfa855SEd Maste.\" 14*2ccfa855SEd Maste.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 15*2ccfa855SEd Maste.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 16*2ccfa855SEd Maste.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 17*2ccfa855SEd Maste.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 18*2ccfa855SEd Maste.\" HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 19*2ccfa855SEd Maste.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 20*2ccfa855SEd Maste.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21*2ccfa855SEd Maste.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22*2ccfa855SEd Maste.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23*2ccfa855SEd Maste.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 24*2ccfa855SEd Maste.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25*2ccfa855SEd Maste.\" 26*2ccfa855SEd Maste.\" SPDX-License-Identifier: BSD-2-Clause 270afa8e06SEd Maste.\" 280afa8e06SEd Maste.Dd $Mdocdate: September 13 2019 $ 290afa8e06SEd Maste.Dt FIDO_BIO_INFO_NEW 3 300afa8e06SEd Maste.Os 310afa8e06SEd Maste.Sh NAME 320afa8e06SEd Maste.Nm fido_bio_info_new , 330afa8e06SEd Maste.Nm fido_bio_info_free , 340afa8e06SEd Maste.Nm fido_bio_info_type , 350afa8e06SEd Maste.Nm fido_bio_info_max_samples 360afa8e06SEd Maste.Nd FIDO2 biometric sensor information API 370afa8e06SEd Maste.Sh SYNOPSIS 380afa8e06SEd Maste.In fido.h 390afa8e06SEd Maste.In fido/bio.h 400afa8e06SEd Maste.Ft fido_bio_info_t * 410afa8e06SEd Maste.Fn fido_bio_info_new "void" 420afa8e06SEd Maste.Ft void 430afa8e06SEd Maste.Fn fido_bio_info_free "fido_bio_info_t **info_p" 440afa8e06SEd Maste.Ft uint8_t 450afa8e06SEd Maste.Fn fido_bio_info_type "const fido_bio_info_t *info" 460afa8e06SEd Maste.Ft uint8_t 470afa8e06SEd Maste.Fn fido_bio_info_max_samples "const fido_bio_info_t *info" 480afa8e06SEd Maste.Sh DESCRIPTION 490afa8e06SEd MasteBiometric sensor metadata is abstracted in 500afa8e06SEd Maste.Em libfido2 510afa8e06SEd Masteby the 520afa8e06SEd Maste.Vt fido_bio_info_t 530afa8e06SEd Mastetype. 540afa8e06SEd Maste.Pp 550afa8e06SEd MasteThe functions described in this page allow a 560afa8e06SEd Maste.Vt fido_bio_info_t 570afa8e06SEd Mastetype to be allocated, deallocated, and inspected. 580afa8e06SEd MasteFor device operations on 590afa8e06SEd Maste.Vt fido_bio_info_t , 600afa8e06SEd Masteplease refer to 610afa8e06SEd Maste.Xr fido_bio_dev_get_info 3 . 620afa8e06SEd Maste.Pp 630afa8e06SEd MasteThe 640afa8e06SEd Maste.Fn fido_bio_info_new 650afa8e06SEd Mastefunction returns a pointer to a newly allocated, empty 660afa8e06SEd Maste.Vt fido_bio_info_t 670afa8e06SEd Mastetype. 680afa8e06SEd MasteIf memory cannot be allocated, NULL is returned. 690afa8e06SEd Maste.Pp 700afa8e06SEd MasteThe 710afa8e06SEd Maste.Fn fido_bio_info_free 720afa8e06SEd Mastefunction releases the memory backing 730afa8e06SEd Maste.Fa *info_p , 740afa8e06SEd Mastewhere 750afa8e06SEd Maste.Fa *info_p 760afa8e06SEd Mastemust have been previously allocated by 770afa8e06SEd Maste.Fn fido_bio_info_new . 780afa8e06SEd MasteOn return, 790afa8e06SEd Maste.Fa *info_p 800afa8e06SEd Masteis set to NULL. 810afa8e06SEd MasteEither 820afa8e06SEd Maste.Fa info_p 830afa8e06SEd Masteor 840afa8e06SEd Maste.Fa *info_p 850afa8e06SEd Mastemay be NULL, in which case 860afa8e06SEd Maste.Fn fido_bio_info_free 870afa8e06SEd Masteis a NOP. 880afa8e06SEd Maste.Pp 890afa8e06SEd MasteThe 900afa8e06SEd Maste.Fn fido_bio_info_type 910afa8e06SEd Mastefunction returns the fingerprint sensor type, which is 920afa8e06SEd Maste.Dv 1 930afa8e06SEd Mastefor touch sensors, and 940afa8e06SEd Maste.Dv 2 950afa8e06SEd Mastefor swipe sensors. 960afa8e06SEd Maste.Pp 970afa8e06SEd MasteThe 980afa8e06SEd Maste.Fn fido_bio_info_max_samples 990afa8e06SEd Mastefunction returns the maximum number of successful samples 1000afa8e06SEd Masterequired for enrollment. 1010afa8e06SEd Maste.Sh SEE ALSO 1020afa8e06SEd Maste.Xr fido_bio_dev_get_info 3 , 1030afa8e06SEd Maste.Xr fido_bio_enroll_new 3 , 1040afa8e06SEd Maste.Xr fido_bio_template 3 105