1*2ccfa855SEd Maste.\" Copyright (c) 2018-2022 Yubico AB. All rights reserved. 20afa8e06SEd 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 27*2ccfa855SEd Maste.\" 28*2ccfa855SEd Maste.Dd $Mdocdate: December 2 2022 $ 290afa8e06SEd Maste.Dt FIDO_CRED_EXCLUDE 3 300afa8e06SEd Maste.Os 310afa8e06SEd Maste.Sh NAME 32*2ccfa855SEd Maste.Nm fido_cred_exclude , 33*2ccfa855SEd Maste.Nm fido_cred_empty_exclude_list 34*2ccfa855SEd Maste.Nd manage exclude lists in a FIDO2 credential 350afa8e06SEd Maste.Sh SYNOPSIS 360afa8e06SEd Maste.In fido.h 370afa8e06SEd Maste.Ft int 380afa8e06SEd Maste.Fn fido_cred_exclude "fido_cred_t *cred" "const unsigned char *ptr" "size_t len" 39*2ccfa855SEd Maste.Ft int 40*2ccfa855SEd Maste.Fn fido_cred_empty_exclude_list "fido_cred_t *cred" 410afa8e06SEd Maste.Sh DESCRIPTION 420afa8e06SEd MasteThe 430afa8e06SEd Maste.Fn fido_cred_exclude 440afa8e06SEd Mastefunction adds 450afa8e06SEd Maste.Fa ptr 460afa8e06SEd Masteto the list of credentials excluded by 470afa8e06SEd Maste.Fa cred , 480afa8e06SEd Mastewhere 490afa8e06SEd Maste.Fa ptr 500afa8e06SEd Mastepoints to a credential ID of 510afa8e06SEd Maste.Fa len 520afa8e06SEd Mastebytes. 530afa8e06SEd MasteA copy of 540afa8e06SEd Maste.Fa ptr 550afa8e06SEd Masteis made, and no references to the passed pointer are kept. 560afa8e06SEd MasteIf 570afa8e06SEd Maste.Fn fido_cred_exclude 580afa8e06SEd Mastefails, the existing list of excluded credentials is preserved. 590afa8e06SEd Maste.Pp 600afa8e06SEd MasteIf 610afa8e06SEd Maste.Nm 620afa8e06SEd Mastereturns success and 630afa8e06SEd Maste.Fa cred 640afa8e06SEd Masteis later passed to 650afa8e06SEd Maste.Xr fido_dev_make_cred 3 660afa8e06SEd Masteon a device that contains the credential 670afa8e06SEd Mastedenoted by 680afa8e06SEd Maste.Fa ptr , 690afa8e06SEd Mastethen 700afa8e06SEd Maste.Xr fido_dev_make_cred 3 710afa8e06SEd Mastewill fail. 720afa8e06SEd Maste.Pp 730afa8e06SEd MasteFor the format of a FIDO2 credential ID, please refer to the 740afa8e06SEd MasteWeb Authentication (webauthn) standard. 75*2ccfa855SEd Maste.Pp 76*2ccfa855SEd MasteThe 77*2ccfa855SEd Maste.Fn fido_cred_empty_exclude_list 78*2ccfa855SEd Mastefunction empties the list of credentials excluded by 79*2ccfa855SEd Maste.Fa cred . 800afa8e06SEd Maste.Sh RETURN VALUES 810afa8e06SEd MasteThe error codes returned by 820afa8e06SEd Maste.Fn fido_cred_exclude 83*2ccfa855SEd Masteand 84*2ccfa855SEd Maste.Fn fido_cred_empty_exclude_list 850afa8e06SEd Masteare defined in 860afa8e06SEd Maste.In fido/err.h . 870afa8e06SEd MasteOn success, 880afa8e06SEd Maste.Dv FIDO_OK 890afa8e06SEd Masteis returned. 900afa8e06SEd Maste.Sh SEE ALSO 910afa8e06SEd Maste.Xr fido_cred_new 3 , 920afa8e06SEd Maste.Xr fido_cred_set_authdata 3 , 930afa8e06SEd Maste.Xr fido_dev_make_cred 3 94