Add missing quoting in manpage. Patch from Nicolas Joly.
[heimdal.git] / lib / krb5 / time.c
blob247549ba2372d3e763966bd28222ae432e2d95d4
1 /*
2 * Copyright (c) 1997-2004 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
4 * All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the Institute nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
34 #include "krb5_locl.h"
36 /**
37 * Set the absolute time that the caller knows the kdc has so the
38 * kerberos library can calculate the relative diffrence beteen the
39 * KDC time and local system time.
41 * @param context Keberos 5 context.
42 * @param sec The applications new of "now" in seconds
43 * @param usec The applications new of "now" in micro seconds
45 * @return Kerberos 5 error code, see krb5_get_error_message().
47 * @ingroup krb5
50 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
51 krb5_set_real_time (krb5_context context,
52 krb5_timestamp sec,
53 int32_t usec)
55 struct timeval tv;
57 gettimeofday(&tv, NULL);
59 context->kdc_sec_offset = sec - tv.tv_sec;
61 /**
62 * If the caller passes in a negative usec, its assumed to be
63 * unknown and the function will use the current time usec.
65 if (usec >= 0) {
66 context->kdc_usec_offset = usec - tv.tv_usec;
68 if (context->kdc_usec_offset < 0) {
69 context->kdc_sec_offset--;
70 context->kdc_usec_offset += 1000000;
72 } else
73 context->kdc_usec_offset = tv.tv_usec;
75 return 0;
79 * return ``corrected'' time in `timeret'.
82 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
83 krb5_timeofday (krb5_context context,
84 krb5_timestamp *timeret)
86 *timeret = time(NULL) + context->kdc_sec_offset;
87 return 0;
91 * like gettimeofday but with time correction to the KDC
94 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
95 krb5_us_timeofday (krb5_context context,
96 krb5_timestamp *sec,
97 int32_t *usec)
99 struct timeval tv;
101 gettimeofday (&tv, NULL);
103 *sec = tv.tv_sec + context->kdc_sec_offset;
104 *usec = tv.tv_usec; /* XXX */
105 return 0;
108 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
109 krb5_format_time(krb5_context context, time_t t,
110 char *s, size_t len, krb5_boolean include_time)
112 struct tm *tm;
113 if(context->log_utc)
114 tm = gmtime (&t);
115 else
116 tm = localtime(&t);
117 if(tm == NULL ||
118 strftime(s, len, include_time ? context->time_fmt : context->date_fmt, tm) == 0)
119 snprintf(s, len, "%ld", (long)t);
120 return 0;
123 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
124 krb5_string_to_deltat(const char *string, krb5_deltat *deltat)
126 if((*deltat = parse_time(string, "s")) == -1)
127 return KRB5_DELTAT_BADFORMAT;
128 return 0;