diff options
Diffstat (limited to 'man/fido_dev_get_touch_begin.3')
-rw-r--r-- | man/fido_dev_get_touch_begin.3 | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/man/fido_dev_get_touch_begin.3 b/man/fido_dev_get_touch_begin.3 new file mode 100644 index 0000000..8372c6f --- /dev/null +++ b/man/fido_dev_get_touch_begin.3 | |||
@@ -0,0 +1,73 @@ | |||
1 | .\" Copyright (c) 2020 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: August 5 2020 $ | ||
6 | .Dt FIDO_DEV_GET_TOUCH_BEGIN 3 | ||
7 | .Os | ||
8 | .Sh NAME | ||
9 | .Nm fido_dev_get_touch_begin , | ||
10 | .Nm fido_dev_get_touch_status | ||
11 | .Nd asynchronously wait for touch on a FIDO 2 authenticator | ||
12 | .Sh SYNOPSIS | ||
13 | .In fido.h | ||
14 | .Ft int | ||
15 | .Fn fido_dev_get_touch_begin "fido_dev_t *dev" | ||
16 | .Ft int | ||
17 | .Fn fido_dev_get_touch_status "fido_dev_t *dev" "int *touched" "int ms" | ||
18 | .Sh DESCRIPTION | ||
19 | The functions described in this page allow an application to | ||
20 | asynchronously wait for touch on a FIDO authenticator. | ||
21 | This is useful when multiple authenticators are present and | ||
22 | the application needs to know which one to use. | ||
23 | .Pp | ||
24 | The | ||
25 | .Fn fido_dev_get_touch_begin | ||
26 | function initiates a touch request on | ||
27 | .Fa dev . | ||
28 | .Pp | ||
29 | The | ||
30 | .Fn fido_dev_get_touch_status | ||
31 | function continues an ongoing touch request on | ||
32 | .Fa dev , | ||
33 | blocking up to | ||
34 | .Fa ms | ||
35 | milliseconds. | ||
36 | On success, | ||
37 | .Fa touched | ||
38 | will be updated to reflect the touch request status. | ||
39 | If | ||
40 | .Fa touched | ||
41 | is 1, the device was touched, and the touch request is | ||
42 | terminated. | ||
43 | If | ||
44 | .Fa touched | ||
45 | is 0, the application may call | ||
46 | .Fn fido_dev_get_touch_status | ||
47 | to continue the touch request, or | ||
48 | .Fn fido_dev_cancel | ||
49 | to terminate it. | ||
50 | .Sh RETURN VALUES | ||
51 | The error codes returned by | ||
52 | .Fn fido_dev_get_touch_begin | ||
53 | and | ||
54 | .Fn fido_dev_get_touch_status | ||
55 | are defined in | ||
56 | .In fido/err.h . | ||
57 | On success, | ||
58 | .Dv FIDO_OK | ||
59 | is returned. | ||
60 | .Sh EXAMPLES | ||
61 | Please refer to | ||
62 | .Em examples/select.c | ||
63 | in | ||
64 | .Em libfido2's | ||
65 | source tree. | ||
66 | .Sh SEE ALSO | ||
67 | .Xr fido_dev_cancel 3 | ||
68 | .Sh CAVEATS | ||
69 | The | ||
70 | .Fn fido_dev_get_touch_status | ||
71 | function will cause a command to be transmitted to U2F | ||
72 | authenticators. | ||
73 | These transmissions should not exceed a frequency of 5Hz. | ||