File: pskc_get_key_data_timedrift.3

package info (click to toggle)
oath-toolkit 2.6.1-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 20,824 kB
  • ctags: 9,237
  • sloc: ansic: 54,713; sh: 13,738; yacc: 1,254; xml: 756; makefile: 353
file content (38 lines) | stat: -rw-r--r-- 1,636 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "pskc_get_key_data_timedrift" 3 "2.6.1" "libpskc" "libpskc"
.SH NAME
pskc_get_key_data_timedrift \- API function
.SH SYNOPSIS
.B #include <pskc.h>
.sp
.BI "uint32_t pskc_get_key_data_timedrift(pskc_key_t * " key ", int * " present ");"
.SH ARGUMENTS
.IP "pskc_key_t * key" 12
a \fBpskc_key_t\fP handle, from \fBpskc_get_keypackage()\fP.
.IP "int * present" 12
output variable indicating whether data was provided or not.
.SH "DESCRIPTION"
Get the PSKC KeyPackage Key Data TimeDrift value.  This element
contains the device clock drift value for time\-based OTP
algorithms.  The integer value (positive or negative drift) that
indicates the number of time intervals that a validation server has
established the device clock drifted after the last successful
authentication.  So, for example, if the last successful
authentication established a device time value of 8 intervals from
a specific start date but the validation server determines the time
value at 9 intervals, the server SHOULD record the drift as \-1.

If \fIpresent\fP is non\-NULL, it will be 0 if the field is not present
or 1 if it was present.
.SH "RETURNS"
an integer holding the content.
.SH "REPORTING BUGS"
Report bugs to <oath-toolkit-help@nongnu.org>.
libpskc home page: http://www.gnu.org/software/libpskc/
General help using GNU software: http://www.gnu.org/gethelp/
.SH COPYRIGHT
Copyright \(co 2012-2015 Simon Josefsson.
.br
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.