diff options
author | nicoo <nicoo@debian.org> | 2020-02-12 13:42:22 +0100 |
---|---|---|
committer | Nicolas Braud-Santoni <nicolas@braud-santoni.eu> | 2020-02-12 13:42:22 +0100 |
commit | c79050aa44b8836d836c5dd22a383a073c28b74b (patch) | |
tree | 7bcca9fabd7718bf87ca600a6594f57b76d8de7d /man/fido_cred_exclude.3 |
Import upstream release 1.3.0
Closes: #951184
Diffstat (limited to 'man/fido_cred_exclude.3')
-rw-r--r-- | man/fido_cred_exclude.3 | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/man/fido_cred_exclude.3 b/man/fido_cred_exclude.3 new file mode 100644 index 0000000..700d6af --- /dev/null +++ b/man/fido_cred_exclude.3 | |||
@@ -0,0 +1,60 @@ | |||
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 | ||
16 | The | ||
17 | .Fn fido_cred_exclude | ||
18 | function adds | ||
19 | .Fa ptr | ||
20 | to the list of credentials excluded by | ||
21 | .Fa cred , | ||
22 | where | ||
23 | .Fa ptr | ||
24 | points to a credential ID of | ||
25 | .Fa len | ||
26 | bytes. | ||
27 | A copy of | ||
28 | .Fa ptr | ||
29 | is made, and no references to the passed pointer are kept. | ||
30 | If | ||
31 | .Fn fido_cred_exclude | ||
32 | fails, the existing list of excluded credentials is preserved. | ||
33 | .Pp | ||
34 | If | ||
35 | .Nm | ||
36 | returns success and | ||
37 | .Fa cred | ||
38 | is later passed to | ||
39 | .Xr fido_dev_make_cred 3 | ||
40 | on a device that contains the credential | ||
41 | denoted by | ||
42 | .Fa ptr , | ||
43 | then | ||
44 | .Xr fido_dev_make_cred 3 | ||
45 | will fail. | ||
46 | .Pp | ||
47 | For the format of a FIDO 2 credential ID, please refer to the | ||
48 | Web Authentication (webauthn) standard. | ||
49 | .Sh RETURN VALUES | ||
50 | The error codes returned by | ||
51 | .Fn fido_cred_exclude | ||
52 | are defined in | ||
53 | .In fido/err.h . | ||
54 | On success, | ||
55 | .Dv FIDO_OK | ||
56 | is 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 | ||