2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2012 The OpenLDAP Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
11 * A copy of this license is available in file LICENSE in the
12 * top-level directory of the distribution or, alternatively, at
13 * <http://www.OpenLDAP.org/license.html>.
19 #include <ldap_cdefs.h>
20 #include <lber_types.h>
23 * Include file for LDAP utility routine
28 /* n octets encode into ceiling(n/3) * 4 bytes */
29 /* Avoid floating point math through extra padding */
31 #define LUTIL_BASE64_ENCODE_LEN(n) (((n)+2)/3 * 4)
32 #define LUTIL_BASE64_DECODE_LEN(n) ((n)/4*3)
34 /* ISC Base64 Routines */
38 lutil_b64_ntop LDAP_P((
39 unsigned char const *,
45 lutil_b64_pton LDAP_P((
58 lutil_entropy LDAP_P((
63 struct berval; /* avoid pulling in lber.h */
66 lutil_get_filed_password LDAP_P((
71 struct lutil_pw_scheme;
73 #define LUTIL_PASSWD_OK (0)
74 #define LUTIL_PASSWD_ERR (-1)
76 typedef int (LUTIL_PASSWD_CHK_FUNC)(
77 const struct berval *scheme,
78 const struct berval *passwd,
79 const struct berval *cred,
82 typedef int (LUTIL_PASSWD_HASH_FUNC) (
83 const struct berval *scheme,
84 const struct berval *passwd,
89 lutil_passwd_add LDAP_P((
90 struct berval *scheme,
91 LUTIL_PASSWD_CHK_FUNC *chk_fn,
92 LUTIL_PASSWD_HASH_FUNC *hash_fn ));
95 lutil_passwd_init LDAP_P(( void ));
98 lutil_passwd_destroy LDAP_P(( void ));
101 lutil_authpasswd LDAP_P((
102 const struct berval *passwd, /* stored password */
103 const struct berval *cred, /* user supplied value */
104 const char **methods ));
107 lutil_authpasswd_hash LDAP_P((
108 const struct berval *cred,
109 struct berval **passwd, /* password to store */
110 struct berval **salt, /* salt to store */
111 const char *method ));
114 typedef int (lutil_cryptfunc) LDAP_P((
118 LDAP_LUTIL_V (lutil_cryptfunc *) lutil_cryptptr;
122 lutil_passwd LDAP_P((
123 const struct berval *passwd, /* stored password */
124 const struct berval *cred, /* user supplied value */
125 const char **methods,
126 const char **text )); /* error message */
129 lutil_passwd_generate LDAP_P(( struct berval *pw, ber_len_t ));
132 lutil_passwd_hash LDAP_P((
133 const struct berval *passwd,
136 const char **text ));
139 lutil_passwd_scheme LDAP_P((
140 const char *scheme ));
143 lutil_salt_format LDAP_P((
144 const char *format ));
147 lutil_passwd_string64 LDAP_P((
148 const struct berval *sc,
149 const struct berval *hash,
151 const struct berval *salt ));
154 LDAP_LUTIL_F( char* )
155 lutil_progname LDAP_P((
160 typedef struct lutil_tm {
161 int tm_sec; /* seconds 0-60 (1 leap second) */
162 int tm_min; /* minutes 0-59 */
163 int tm_hour; /* hours 0-23 */
164 int tm_mday; /* day 1-31 */
165 int tm_mon; /* month 0-11 */
166 int tm_year; /* year - 1900 */
167 int tm_usec; /* microseconds */
168 int tm_usub; /* submicro */
171 typedef struct lutil_timet {
172 unsigned int tt_sec; /* seconds since 1900 */
173 int tt_gsec; /* seconds since 1900, high 7 bits */
174 unsigned int tt_usec; /* microseconds */
177 /* Parse a timestamp string into a structure */
179 lutil_parsetime LDAP_P((
180 char *atm, struct lutil_tm * ));
182 /* Convert structured time to time in seconds since 1900 */
184 lutil_tm2time LDAP_P((
185 struct lutil_tm *, struct lutil_timet * ));
189 lutil_slashpath LDAP_P(( char* path ));
190 #define LUTIL_SLASHPATH(p) lutil_slashpath(p)
192 #define LUTIL_SLASHPATH(p)
195 LDAP_LUTIL_F( char* )
196 lutil_strcopy LDAP_P(( char *dst, const char *src ));
198 LDAP_LUTIL_F( char* )
199 lutil_strncopy LDAP_P(( char *dst, const char *src, size_t n ));
201 LDAP_LUTIL_F( char* )
202 lutil_memcopy LDAP_P(( char *dst, const char *src, size_t n ));
204 #define lutil_strbvcopy(a, bv) lutil_memcopy((a),(bv)->bv_val,(bv)->bv_len)
208 /* use this macro to statically allocate buffer for lutil_gentime */
209 #define LDAP_LUTIL_GENTIME_BUFSIZE 22
210 #define lutil_gentime(s,m,t) lutil_localtime((s),(m),(t),0)
211 LDAP_LUTIL_F( size_t )
212 lutil_localtime LDAP_P(( char *s, size_t smax, const struct tm *tm,
217 mkstemp LDAP_P (( char * template ));
222 lutil_pair( ber_socket_t sd[2] );
225 /* use this macro to allocate buffer for lutil_uuidstr */
226 #define LDAP_LUTIL_UUIDSTR_BUFSIZE 40
227 LDAP_LUTIL_F( size_t )
228 lutil_uuidstr( char *buf, size_t len );
231 lutil_uuidstr_from_normalized(
238 * Sometimes not all declarations in a header file are needed.
239 * An indicator to this is whether or not the symbol's type has
240 * been defined. Thus, we don't need to include a symbol if
241 * its type has not been defined through another header file.
244 #ifdef HAVE_NT_SERVICE_MANAGER
245 LDAP_LUTIL_V (int) is_NT_Service;
247 #ifdef _LDAP_PVT_THREAD_H
248 LDAP_LUTIL_V (ldap_pvt_thread_cond_t) started_event;
249 #endif /* _LDAP_PVT_THREAD_H */
251 /* macros are different between Windows and Mingw */
252 #if defined(_WINSVC_H) || defined(_WINSVC_)
253 LDAP_LUTIL_V (SERVICE_STATUS) lutil_ServiceStatus;
254 LDAP_LUTIL_V (SERVICE_STATUS_HANDLE) hlutil_ServiceStatus;
255 #endif /* _WINSVC_H */
258 lutil_CommenceStartupProcessing( char *serverName, void (*stopper)(int)) ;
261 lutil_ReportShutdownComplete( void );
263 LDAP_LUTIL_F (void *)
264 lutil_getRegParam( char *svc, char *value );
267 lutil_srv_install( char* service, char * displayName, char* filename,
270 lutil_srv_remove ( char* service, char* filename );
272 #endif /* HAVE_NT_SERVICE_MANAGER */
274 #ifdef HAVE_NT_EVENT_LOG
276 lutil_LogStartedEvent( char *svc, int slap_debug, char *configfile, char *urls );
279 lutil_LogStoppedEvent( char *svc );
283 /* Generally this has only been used to put '\n' to stdout. We need to
284 * make sure it is output in EBCDIC.
288 #define putchar(c) putc((c), stdout)
289 #define putc(c,fp) do { char x=(c); __atoe_l(&x,1); putc(x,fp); } while(0)
293 lutil_atoix( int *v, const char *s, int x );
296 lutil_atoux( unsigned *v, const char *s, int x );
299 lutil_atolx( long *v, const char *s, int x );
302 lutil_atoulx( unsigned long *v, const char *s, int x );
304 #define lutil_atoi(v, s) lutil_atoix((v), (s), 10)
305 #define lutil_atou(v, s) lutil_atoux((v), (s), 10)
306 #define lutil_atol(v, s) lutil_atolx((v), (s), 10)
307 #define lutil_atoul(v, s) lutil_atoulx((v), (s), 10)
309 #ifdef HAVE_LONG_LONG
310 #if defined(HAVE_STRTOLL) || defined(HAVE_STRTOQ)
312 lutil_atollx( long long *v, const char *s, int x );
313 #define lutil_atoll(v, s) lutil_atollx((v), (s), 10)
314 #endif /* HAVE_STRTOLL || HAVE_STRTOQ */
316 #if defined(HAVE_STRTOULL) || defined(HAVE_STRTOUQ)
318 lutil_atoullx( unsigned long long *v, const char *s, int x );
319 #define lutil_atoull(v, s) lutil_atoullx((v), (s), 10)
320 #endif /* HAVE_STRTOULL || HAVE_STRTOUQ */
321 #endif /* HAVE_LONG_LONG */
324 lutil_str2bin( struct berval *in, struct berval *out, void *ctx );
326 /* Parse and unparse time intervals */
328 lutil_parse_time( const char *in, unsigned long *tp );
331 lutil_unparse_time( char *buf, size_t buflen, unsigned long t );
334 #define lutil_timerdiv timerdiv
335 #else /* ! timerdiv */
336 /* works inplace (x == t) */
337 #define lutil_timerdiv(t,d,x) \
339 time_t s = (t)->tv_sec; \
341 (x)->tv_sec = s / d; \
342 (x)->tv_usec = ( (t)->tv_usec + 1000000 * ( s % d ) ) / d; \
344 #endif /* ! timerdiv */
347 #define lutil_timermul timermul
348 #else /* ! timermul */
349 /* works inplace (x == t) */
350 #define lutil_timermul(t,m,x) \
352 time_t u = (t)->tv_usec * m; \
354 (x)->tv_sec = (t)->tv_sec * m + u / 1000000; \
355 (x)->tv_usec = u % 1000000; \
357 #endif /* ! timermul */
361 #endif /* _LUTIL_H */