1.\" Copyright (c) 2018 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: May 23 2018 $ 6.Dt FIDO_CRED_EXCLUDE 3 7.Os 8.Sh NAME 9.Nm fido_cred_exclude 10.Nd appends a credential ID to a credential's list of excluded credentials 11.Sh SYNOPSIS 12.In fido.h 13.Ft int 14.Fn fido_cred_exclude "fido_cred_t *cred" "const unsigned char *ptr" "size_t len" 15.Sh DESCRIPTION 16The 17.Fn fido_cred_exclude 18function adds 19.Fa ptr 20to the list of credentials excluded by 21.Fa cred , 22where 23.Fa ptr 24points to a credential ID of 25.Fa len 26bytes. 27A copy of 28.Fa ptr 29is made, and no references to the passed pointer are kept. 30If 31.Fn fido_cred_exclude 32fails, the existing list of excluded credentials is preserved. 33.Pp 34If 35.Nm 36returns success and 37.Fa cred 38is later passed to 39.Xr fido_dev_make_cred 3 40on a device that contains the credential 41denoted by 42.Fa ptr , 43then 44.Xr fido_dev_make_cred 3 45will fail. 46.Pp 47For the format of a FIDO2 credential ID, please refer to the 48Web Authentication (webauthn) standard. 49.Sh RETURN VALUES 50The error codes returned by 51.Fn fido_cred_exclude 52are defined in 53.In fido/err.h . 54On success, 55.Dv FIDO_OK 56is returned. 57.Sh SEE ALSO 58.Xr fido_cred_new 3 , 59.Xr fido_cred_set_authdata 3 , 60.Xr fido_dev_make_cred 3 61