xref: /freebsd/crypto/heimdal/lib/krb5/krb5_timeofday.3 (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
1.\" $Id$
2.\"
3.\" Copyright (c) 2001, 2003, 2006 Kungliga Tekniska Högskolan
4.\" (Royal Institute of Technology, Stockholm, Sweden).
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\"
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\"
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" 3. Neither the name of the Institute nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\" $Id$
35.\"
36.Dd Sepember  16, 2006
37.Dt KRB5_TIMEOFDAY 3
38.Os HEIMDAL
39.Sh NAME
40.Nm krb5_timeofday ,
41.Nm krb5_set_real_time ,
42.Nm krb5_us_timeofday ,
43.Nm krb5_format_time ,
44.Nm krb5_string_to_deltat
45.Nd Kerberos 5 time handling functions
46.Sh LIBRARY
47Kerberos 5 Library (libkrb5, -lkrb5)
48.Sh SYNOPSIS
49.In krb5.h
50.Pp
51.Li krb5_timestamp ;
52.Pp
53.Li krb5_deltat ;
54.Ft krb5_error_code
55.Fo krb5_set_real_time
56.Fa "krb5_context context"
57.Fa "krb5_timestamp sec"
58.Fa "int32_t usec"
59.Fc
60.Ft krb5_error_code
61.Fo krb5_timeofday
62.Fa "krb5_context context"
63.Fa "krb5_timestamp *timeret"
64.Fc
65.Ft krb5_error_code
66.Fo krb5_us_timeofday
67.Fa "krb5_context context"
68.Fa "krb5_timestamp *sec"
69.Fa "int32_t *usec"
70.Fc
71.Ft krb5_error_code
72.Fo krb5_format_time
73.Fa "krb5_context context"
74.Fa "time_t t"
75.Fa "char *s"
76.Fa "size_t len"
77.Fa "krb5_boolean include_time"
78.Fc
79.Ft krb5_error_code
80.Fo krb5_string_to_deltat
81.Fa "const char *string"
82.Fa "krb5_deltat *deltat"
83.Fc
84.Sh DESCRIPTION
85.Nm krb5_set_real_time
86sets the absolute time that the caller knows the KDC has.
87With this the Kerberos library can calculate the relative
88difference between the KDC time and the local system time and store it
89in the
90.Fa context .
91With this information the Kerberos library can adjust all time stamps
92in Kerberos packages.
93.Pp
94.Fn krb5_timeofday
95returns the current time, but adjusted with the time difference
96between the local host and the KDC.
97.Fn krb5_us_timeofday
98also returns microseconds.
99.Pp
100.Nm krb5_format_time
101formats the time
102.Fa t
103into the string
104.Fa s
105of length
106.Fa len .
107If
108.Fa include_time
109is set, the time is set include_time.
110.Pp
111.Nm krb5_string_to_deltat
112parses delta time
113.Fa string
114into
115.Fa deltat .
116.Sh SEE ALSO
117.Xr gettimeofday 2 ,
118.Xr krb5 3
119