2 * ntp_stdlib.h - Prototypes for NTP lib.
8 #ifdef HAVE_SYS_SOCKET_H
9 #include <sys/socket.h>
12 #include "declcond.h" /* ntpd uses ntpd/declcond.h, others include/ */
15 #include "ntp_debug.h"
16 #include "ntp_malloc.h"
17 #include "ntp_string.h"
18 #include "ntp_syslog.h"
19 #include "ntp_keyacc.h"
22 #define NTP_PRINTF(fmt, args) __attribute__((__format__(__printf__, fmt, args)))
24 #define NTP_PRINTF(fmt, args)
27 extern int mprintf(const char *, ...) NTP_PRINTF(1, 2);
28 extern int mfprintf(FILE *, const char *, ...) NTP_PRINTF(2, 3);
29 extern int mvfprintf(FILE *, const char *, va_list) NTP_PRINTF(2, 0);
30 extern int mvsnprintf(char *, size_t, const char *, va_list)
32 extern int msnprintf(char *, size_t, const char *, ...)
34 extern void msyslog(int, const char *, ...) NTP_PRINTF(2, 3);
35 extern void mvsyslog(int, const char *, va_list) NTP_PRINTF(2, 0);
36 extern void init_logging (const char *, u_int32, int);
37 extern int change_logfile (const char *, int);
38 extern void setup_logfile (const char *);
40 extern void errno_to_str(int, char *, size_t);
44 * When building without OpenSSL, use a few macros of theirs to
45 * minimize source differences in NTP.
48 #define NID_md5 4 /* from openssl/objects.h */
49 /* from openssl/evp.h */
50 #define EVP_MAX_MD_SIZE 64 /* longest known is SHA512 */
53 #define SAVE_ERRNO(stmt) \
55 int preserved_errno; \
57 preserved_errno = socket_errno(); \
61 errno = preserved_errno; \
64 typedef void (*ctrl_c_fn)(void);
67 extern void auth_delkeys (void);
68 extern int auth_havekey (keyid_t);
69 extern int authdecrypt (keyid_t, u_int32 *, size_t, size_t);
70 extern size_t authencrypt (keyid_t, u_int32 *, size_t);
71 extern int authhavekey (keyid_t);
72 extern int authistrusted (keyid_t);
73 extern int authistrustedip (keyid_t, sockaddr_u *);
74 extern int authreadkeys (const char *);
75 extern void authtrust (keyid_t, u_long);
76 extern int authusekey (keyid_t, int, const u_char *);
79 * Based on the NTP timestamp, calculate the NTP timestamp of
80 * the corresponding calendar unit. Use the pivot time to unfold
81 * the NTP timestamp properly, or the current system time if the
82 * pivot pointer is NULL.
84 extern u_int32 calyearstart (u_int32 ntptime, const time_t *pivot);
85 extern u_int32 calmonthstart (u_int32 ntptime, const time_t *pivot);
86 extern u_int32 calweekstart (u_int32 ntptime, const time_t *pivot);
87 extern u_int32 caldaystart (u_int32 ntptime, const time_t *pivot);
89 extern const char *clockname (int);
90 extern int clocktime (int, int, int, int, int, u_int32, u_long *, u_int32 *);
91 extern int ntp_getopt (int, char **, const char *);
92 extern void init_auth (void);
93 extern void init_lib (void);
94 extern struct savekey *auth_findkey (keyid_t);
95 extern void auth_moremem (int);
96 extern void auth_prealloc_symkeys(int);
97 extern int ymd2yd (int, int, int);
100 extern int MD5authdecrypt (int, const u_char *, u_int32 *, size_t, size_t);
101 extern size_t MD5authencrypt (int, const u_char *, u_int32 *, size_t);
102 extern void MD5auth_setkey (keyid_t, int, const u_char *, size_t, KeyAccT *c);
103 extern u_int32 addr2refid (sockaddr_u *);
106 #ifndef EREALLOC_CALLSITE /* ntp_malloc.h defines */
107 extern void * ereallocz (void *, size_t, size_t, int);
108 extern void * oreallocarrayxz (void *optr, size_t nmemb, size_t size, size_t extra);
109 #define erealloczsite(p, n, o, z, f, l) ereallocz((p), (n), (o), (z))
110 #define emalloc(n) ereallocz(NULL, (n), 0, FALSE)
111 #define emalloc_zero(c) ereallocz(NULL, (c), 0, TRUE)
112 #define erealloc(p, c) ereallocz((p), (c), 0, FALSE)
113 #define erealloc_zero(p, n, o) ereallocz((p), (n), (o), TRUE)
114 #define ereallocarray(p, n, s) oreallocarrayxz((p), (n), (s), 0)
115 #define eallocarray(n, s) oreallocarrayxz(NULL, (n), (s), 0)
116 #define ereallocarrayxz(p, n, s, x) oreallocarrayxz((p), (n), (s), (x))
117 #define eallocarrayxz(n, s, x) oreallocarrayxz(NULL, (n), (s), (x))
118 extern char * estrdup_impl(const char *);
119 #define estrdup(s) estrdup_impl(s)
121 extern void * ereallocz (void *, size_t, size_t, int,
123 extern void * oreallocarrayxz (void *optr, size_t nmemb, size_t size,
124 size_t extra, const char *, int);
125 #define erealloczsite ereallocz
126 #define emalloc(c) ereallocz(NULL, (c), 0, FALSE, \
128 #define emalloc_zero(c) ereallocz(NULL, (c), 0, TRUE, \
130 #define erealloc(p, c) ereallocz((p), (c), 0, FALSE, \
132 #define erealloc_zero(p, n, o) ereallocz((p), (n), (o), TRUE, \
134 #define ereallocarray(p, n, s) oreallocarrayxz((p), (n), (s), 0, \
136 #define eallocarray(n, s) oreallocarrayxz(NULL, (n), (s), 0, \
138 #define ereallocarrayxz(p, n, s, x) oreallocarrayxz((p), (n), (s), (x), \
140 #define eallocarrayxz(n, s, x) oreallocarrayxz(NULL, (n), (s), (x), \
142 extern char * estrdup_impl(const char *, const char *, int);
143 #define estrdup(s) estrdup_impl((s), __FILE__, __LINE__)
147 extern int atoint (const char *, long *);
148 extern int atouint (const char *, u_long *);
149 extern int hextoint (const char *, u_long *);
150 extern const char * humanlogtime (void);
151 extern const char * humantime (time_t);
152 extern int is_ip_address (const char *, u_short, sockaddr_u *);
153 extern char * mfptoa (u_int32, u_int32, short);
154 extern char * mfptoms (u_int32, u_int32, short);
155 extern const char * modetoa (size_t);
156 extern const char * eventstr (int);
157 extern const char * ceventstr (int);
158 extern const char * res_match_flags(u_short);
159 extern const char * res_access_flags(u_short);
161 extern const char * k_st_flags (u_int32);
163 extern char * statustoa (int, int);
164 extern sockaddr_u * netof (sockaddr_u *);
165 extern char * numtoa (u_int32);
166 extern char * numtohost (u_int32);
167 extern const char * socktoa (const sockaddr_u *);
168 extern const char * sockporttoa(const sockaddr_u *);
169 extern u_short sock_hash (const sockaddr_u *);
170 extern int sockaddr_masktoprefixlen(const sockaddr_u *);
171 extern const char * socktohost (const sockaddr_u *);
172 extern int octtoint (const char *, u_long *);
173 extern u_long ranp2 (int);
174 extern const char *refnumtoa (sockaddr_u *);
175 extern const char *refid_str (u_int32, int);
177 extern int decodenetnum (const char *, sockaddr_u *);
179 extern const char * FindConfig (const char *);
181 extern void signal_no_reset (int, RETSIGTYPE (*func)(int));
182 extern void set_ctrl_c_hook (ctrl_c_fn);
184 extern void getauthkeys (const char *);
185 extern void auth_agekeys (void);
186 extern void rereadkeys (void);
189 * Variable declarations for libntp.
193 extern u_long authkeynotfound; /* keys not found */
194 extern u_long authkeylookups; /* calls to lookup keys */
195 extern u_long authnumkeys; /* number of active keys */
196 extern u_long authkeyexpired; /* key lifetime expirations */
197 extern u_long authkeyuncached; /* cache misses */
198 extern u_long authencryptions; /* calls to encrypt */
199 extern u_long authdecryptions; /* calls to decrypt */
201 extern int authnumfreekeys;
204 * The key cache. We cache the last key we looked at here.
206 extern keyid_t cache_keyid; /* key identifier */
207 extern int cache_type; /* key type */
208 extern u_char * cache_secret; /* secret */
209 extern size_t cache_secretsize; /* secret octets */
210 extern u_short cache_flags; /* KEY_ bit flags */
213 extern char * ntp_optarg; /* global argument pointer */
214 extern int ntp_optind; /* global argv index */
217 extern int ipv4_works;
218 extern int ipv6_works;
221 typedef void (*pset_tod_using)(const char *);
222 extern pset_tod_using set_tod_using;
226 extern void ssl_init (void);
227 extern void ssl_check_version (void);
228 extern int ssl_init_done;
231 if (!ssl_init_done) \
234 #else /* !OPENSSL follows */
235 #define INIT_SSL() do {} while (0)
237 extern int keytype_from_text (const char *, size_t *);
238 extern const char *keytype_name (int);
239 extern char * getpass_keytype (int);
242 #ifndef HAVE_STRLCPY /* + */
244 * Copy src to string dst of size siz. At most siz-1 characters
245 * will be copied. Always NUL terminates (unless siz == 0).
246 * Returns strlen(src); if retval >= siz, truncation occurred.
248 extern size_t strlcpy(char *dst, const char *src, size_t siz);
250 #ifndef HAVE_STRLCAT /* + */
252 * Appends src to string dst of size siz (unlike strncat, siz is the
253 * full size of dst, not space left). At most siz-1 characters
254 * will be copied. Always NUL terminates (unless siz <= strlen(dst)).
255 * Returns strlen(src) + MIN(siz, strlen(initial dst)).
256 * If retval >= siz, truncation occurred.
258 extern size_t strlcat(char *dst, const char *src, size_t siz);
263 /* lib/isc/win32/strerror.c
265 * To minimize Windows-specific changes to the rest of the NTP code,
266 * particularly reference clocks, we hijack calls to strerror() to deal
267 * with our mixture of error codes from the C runtime (open, write)
268 * and Windows (sockets, serial ports). This is an ugly hack because
269 * both use the lowest values differently, but particularly for ntpd,
270 * it's not a problem.
272 #ifdef NTP_REDEFINE_STRERROR
273 #define strerror(e) ntp_strerror(e)
274 extern char * ntp_strerror (int e);
278 extern double sys_tick; /* tick size or time to read */
279 extern double measured_tick; /* non-overridable sys_tick */
280 extern double sys_fuzz; /* min clock read latency */
281 extern int trunc_os_clock; /* sys_tick > measured_tick */
284 extern const char *Version; /* version declaration */
286 #endif /* NTP_STDLIB_H */