diff options
Diffstat (limited to 'man/fido_assert_allow_cred.3')
-rw-r--r-- | man/fido_assert_allow_cred.3 | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/man/fido_assert_allow_cred.3 b/man/fido_assert_allow_cred.3 new file mode 100644 index 0000000..bbe6e4d --- /dev/null +++ b/man/fido_assert_allow_cred.3 | |||
@@ -0,0 +1,47 @@ | |||
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_ASSERT_ALLOW_CRED 3 | ||
7 | .Os | ||
8 | .Sh NAME | ||
9 | .Nm fido_assert_allow_cred | ||
10 | .Nd appends a credential ID to the list of credentials allowed in an assertion | ||
11 | .Sh SYNOPSIS | ||
12 | .In fido.h | ||
13 | .Ft int | ||
14 | .Fn fido_assert_allow_cred "fido_assert_t *assert" "const unsigned char *ptr" "size_t len" | ||
15 | .Sh DESCRIPTION | ||
16 | The | ||
17 | .Fn fido_assert_allow_cred | ||
18 | function adds | ||
19 | .Fa ptr | ||
20 | to the list of credentials allowed in | ||
21 | .Fa assert , | ||
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_assert_allow_cred | ||
32 | fails, the existing list of allowed credentials is preserved. | ||
33 | .Pp | ||
34 | For the format of a FIDO 2 credential ID, please refer to the | ||
35 | Web Authentication (webauthn) standard. | ||
36 | .Sh RETURN VALUES | ||
37 | The error codes returned by | ||
38 | .Fn fido_assert_allow_cred | ||
39 | are defined in | ||
40 | .In fido/err.h . | ||
41 | On success, | ||
42 | .Dv FIDO_OK | ||
43 | is returned. | ||
44 | .Sh SEE ALSO | ||
45 | .Xr fido_assert_new 3 , | ||
46 | .Xr fido_assert_set_authdata 3 , | ||
47 | .Xr fido_dev_get_assert 3 | ||