crypto/external/bsd/heimdal/dist/lib/krb5/krb5_timeofday.3

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