2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2015 The OpenLDAP Foundation.
5 * Portions Copyright 1998 A. Hartgers.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
17 * This work was initially developed by Bart Hartgers for inclusion in
22 * util-int.c Various functions to replace missing threadsafe ones.
23 * Without the real *_r funcs, things will
24 * work, but might not be threadsafe.
29 #include <ac/stdlib.h>
32 #include <ac/socket.h>
33 #include <ac/string.h>
35 #include <ac/unistd.h>
40 /* newer systems declare this in <netdb.h> for you, older ones don't.
41 * harmless to declare it again (unless defined by a macro).
47 # define HSTRERROR(e) hstrerror(e)
49 # define HSTRERROR(e) hp_strerror(e)
52 #ifndef LDAP_R_COMPILE
53 # undef HAVE_REENTRANT_FUNCTIONS
55 # undef HAVE_GETHOSTBYNAME_R
56 # undef HAVE_GETHOSTBYADDR_R
59 # include <ldap_pvt_thread.h>
60 ldap_pvt_thread_mutex_t ldap_int_resolv_mutex;
61 ldap_pvt_thread_mutex_t ldap_int_hostname_mutex;
62 static ldap_pvt_thread_mutex_t ldap_int_gettime_mutex;
64 # if (defined( HAVE_CTIME_R ) || defined( HAVE_REENTRANT_FUNCTIONS)) \
65 && defined( CTIME_R_NARGS )
68 static ldap_pvt_thread_mutex_t ldap_int_ctime_mutex;
71 /* USE_GMTIME_R and USE_LOCALTIME_R defined in ldap_pvt.h */
73 #if !defined( USE_GMTIME_R ) || !defined( USE_LOCALTIME_R )
74 /* we use the same mutex for gmtime(3) and localtime(3)
75 * because implementations may use the same buffer
76 * for both functions */
77 static ldap_pvt_thread_mutex_t ldap_int_gmtime_mutex;
80 # if defined(HAVE_GETHOSTBYNAME_R) && \
81 (GETHOSTBYNAME_R_NARGS < 5) || (6 < GETHOSTBYNAME_R_NARGS)
82 /* Don't know how to handle this version, pretend it's not there */
83 # undef HAVE_GETHOSTBYNAME_R
85 # if defined(HAVE_GETHOSTBYADDR_R) && \
86 (GETHOSTBYADDR_R_NARGS < 7) || (8 < GETHOSTBYADDR_R_NARGS)
87 /* Don't know how to handle this version, pretend it's not there */
88 # undef HAVE_GETHOSTBYADDR_R
90 #endif /* LDAP_R_COMPILE */
92 char *ldap_pvt_ctime( const time_t *tp, char *buf )
95 # if (CTIME_R_NARGS > 3) || (CTIME_R_NARGS < 2)
96 # error "CTIME_R_NARGS should be 2 or 3"
97 # elif CTIME_R_NARGS > 2 && defined(CTIME_R_RETURNS_INT)
98 return( ctime_r(tp,buf,26) < 0 ? 0 : buf );
99 # elif CTIME_R_NARGS > 2
100 return ctime_r(tp,buf,26);
102 return ctime_r(tp,buf);
107 LDAP_MUTEX_LOCK( &ldap_int_ctime_mutex );
108 AC_MEMCPY( buf, ctime(tp), 26 );
109 LDAP_MUTEX_UNLOCK( &ldap_int_ctime_mutex );
115 #if !defined( USE_GMTIME_R ) || !defined( USE_LOCALTIME_R )
117 ldap_pvt_gmtime_lock( void )
119 # ifndef LDAP_R_COMPILE
121 # else /* LDAP_R_COMPILE */
122 return ldap_pvt_thread_mutex_lock( &ldap_int_gmtime_mutex );
123 # endif /* LDAP_R_COMPILE */
127 ldap_pvt_gmtime_unlock( void )
129 # ifndef LDAP_R_COMPILE
131 # else /* LDAP_R_COMPILE */
132 return ldap_pvt_thread_mutex_unlock( &ldap_int_gmtime_mutex );
133 # endif /* LDAP_R_COMPILE */
135 #endif /* !USE_GMTIME_R || !USE_LOCALTIME_R */
139 ldap_pvt_gmtime( const time_t *timep, struct tm *result )
143 LDAP_MUTEX_LOCK( &ldap_int_gmtime_mutex );
144 tm_ptr = gmtime( timep );
145 if ( tm_ptr == NULL ) {
151 LDAP_MUTEX_UNLOCK( &ldap_int_gmtime_mutex );
155 #endif /* !USE_GMTIME_R */
157 #ifndef USE_LOCALTIME_R
159 ldap_pvt_localtime( const time_t *timep, struct tm *result )
163 LDAP_MUTEX_LOCK( &ldap_int_gmtime_mutex );
164 tm_ptr = localtime( timep );
165 if ( tm_ptr == NULL ) {
171 LDAP_MUTEX_UNLOCK( &ldap_int_gmtime_mutex );
175 #endif /* !USE_LOCALTIME_R */
177 static int _ldap_pvt_gt_subs;
180 /* Windows SYSTEMTIME only has 10 millisecond resolution, so we
181 * also need to use a high resolution timer to get microseconds.
182 * This is pretty clunky.
184 static LARGE_INTEGER _ldap_pvt_gt_freq;
185 static LARGE_INTEGER _ldap_pvt_gt_prev;
186 static int _ldap_pvt_gt_offset;
188 #define SEC_TO_UNIX_EPOCH 11644473600LL
189 #define TICKS_PER_SECOND 10000000
192 ldap_pvt_gettimeusec(int *sec)
196 QueryPerformanceCounter( &count );
198 /* It shouldn't ever go backwards, but multiple CPUs might
199 * be able to hit in the same tick.
201 LDAP_MUTEX_LOCK( &ldap_int_gettime_mutex );
202 /* We assume Windows has at least a vague idea of
203 * when a second begins. So we align our microsecond count
204 * with the Windows millisecond count using this offset.
205 * We retain the submillisecond portion of our own count.
207 * Note - this also assumes that the relationship between
208 * the PerformanceCounter and SystemTime stays constant;
209 * that assumption breaks if the SystemTime is adjusted by
210 * an external action.
212 if ( !_ldap_pvt_gt_freq.QuadPart ) {
219 /* Initialize our offset */
220 QueryPerformanceFrequency( &_ldap_pvt_gt_freq );
222 /* Wait for a tick of the system time: 10-15ms */
223 GetSystemTimeAsFileTime( &ft0 );
225 GetSystemTimeAsFileTime( &ft1 );
226 } while ( ft1.dwLowDateTime == ft0.dwLowDateTime );
228 ut.LowPart = ft1.dwLowDateTime;
229 ut.HighPart = ft1.dwHighDateTime;
230 QueryPerformanceCounter( &c2 );
232 /* get second and fraction portion of counter */
233 t = c2.QuadPart % (_ldap_pvt_gt_freq.QuadPart*10);
235 /* convert to microseconds */
237 usec = t / _ldap_pvt_gt_freq.QuadPart;
240 ut.QuadPart %= 10000000;
241 _ldap_pvt_gt_offset = usec - ut.QuadPart;
244 if ( count.QuadPart <= _ldap_pvt_gt_prev.QuadPart ) {
247 _ldap_pvt_gt_subs = 0;
248 _ldap_pvt_gt_prev = count;
250 LDAP_MUTEX_UNLOCK( &ldap_int_gettime_mutex );
252 /* convert to microseconds */
253 count.QuadPart %= _ldap_pvt_gt_freq.QuadPart*10;
254 count.QuadPart *= 1000000;
255 count.QuadPart /= _ldap_pvt_gt_freq.QuadPart;
256 count.QuadPart -= _ldap_pvt_gt_offset;
258 /* We've extracted the 1s and microseconds.
259 * The 1sec digit is used to detect wraparound in microsecnds.
261 if (count.QuadPart < 0)
262 count.QuadPart += 10000000;
263 else if (count.QuadPart >= 10000000)
264 count.QuadPart -= 10000000;
266 *sec = count.QuadPart / 1000000;
267 return count.QuadPart % 1000000;
271 /* emulate POSIX gettimeofday */
273 ldap_pvt_gettimeofday( struct timeval *tv, void *unused )
279 GetSystemTimeAsFileTime( &ft );
280 ut.LowPart = ft.dwLowDateTime;
281 ut.HighPart = ft.dwHighDateTime;
283 /* convert to usec */
284 ut.QuadPart /= (TICKS_PER_SECOND / 1000000);
286 tv->tv_usec = ldap_pvt_gettimeusec(&sec);
287 tv->tv_sec = ut.QuadPart / 1000000 - SEC_TO_UNIX_EPOCH;
289 /* check for carry from microseconds */
290 sec0 = tv->tv_sec % 10;
291 if (sec0 < sec || (sec0 == 9 && !sec))
297 /* return a broken out time, with microseconds
300 ldap_pvt_gettime( struct lutil_tm *tm )
304 static const char daysPerMonth[] = {
305 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31};
307 GetSystemTime( &st );
308 tm->tm_usec = ldap_pvt_gettimeusec(&sec);
309 tm->tm_usub = _ldap_pvt_gt_subs;
311 /* any difference larger than microseconds is
312 * already reflected in st
314 tm->tm_sec = st.wSecond;
315 tm->tm_min = st.wMinute;
316 tm->tm_hour = st.wHour;
317 tm->tm_mday = st.wDay;
318 tm->tm_mon = st.wMonth - 1;
319 tm->tm_year = st.wYear - 1900;
321 /* check for carry from microseconds */
322 sec0 = tm->tm_sec % 10;
323 if (sec0 < sec || (sec0 == 9 && !sec)) {
325 /* FIXME: we don't handle leap seconds */
326 if (tm->tm_sec > 59) {
329 if (tm->tm_min > 59) {
332 if (tm->tm_hour > 23) {
333 int days = daysPerMonth[tm->tm_mon];
337 /* if it's February of a leap year,
338 * add 1 day to this month
340 if (tm->tm_mon == 1 &&
341 ((!(st.wYear % 4) && (st.wYear % 100)) ||
345 if (tm->tm_mday > days) {
348 if (tm->tm_mon > 11) {
360 static struct timeval _ldap_pvt_gt_prevTv;
363 ldap_pvt_gettime( struct lutil_tm *ltm )
370 gettimeofday( &tv, NULL );
373 LDAP_MUTEX_LOCK( &ldap_int_gettime_mutex );
374 if ( tv.tv_sec < _ldap_pvt_gt_prevTv.tv_sec
375 || ( tv.tv_sec == _ldap_pvt_gt_prevTv.tv_sec
376 && tv.tv_usec <= _ldap_pvt_gt_prevTv.tv_usec )) {
379 _ldap_pvt_gt_subs = 0;
380 _ldap_pvt_gt_prevTv = tv;
382 LDAP_MUTEX_UNLOCK( &ldap_int_gettime_mutex );
384 ltm->tm_usub = _ldap_pvt_gt_subs;
386 ldap_pvt_gmtime( &t, &tm );
388 ltm->tm_sec = tm.tm_sec;
389 ltm->tm_min = tm.tm_min;
390 ltm->tm_hour = tm.tm_hour;
391 ltm->tm_mday = tm.tm_mday;
392 ltm->tm_mon = tm.tm_mon;
393 ltm->tm_year = tm.tm_year;
394 ltm->tm_usec = tv.tv_usec;
399 ldap_pvt_csnstr(char *buf, size_t len, unsigned int replica, unsigned int mod)
404 ldap_pvt_gettime( &tm );
406 n = snprintf( buf, len,
407 "%4d%02d%02d%02d%02d%02d.%06dZ#%06x#%03x#%06x",
408 tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, tm.tm_hour,
409 tm.tm_min, tm.tm_sec, tm.tm_usec, tm.tm_usub, replica, mod );
411 if( n < 0 ) return 0;
412 return ( (size_t) n < len ) ? n : 0;
415 #define BUFSTART (1024-32)
416 #define BUFMAX (32*1024-32)
418 #if defined(LDAP_R_COMPILE)
419 static char *safe_realloc( char **buf, int len );
421 #if !(defined(HAVE_GETHOSTBYNAME_R) && defined(HAVE_GETHOSTBYADDR_R))
422 static int copy_hostent( struct hostent *res,
423 char **buf, struct hostent * src );
427 int ldap_pvt_gethostbyname_a(
429 struct hostent *resbuf,
431 struct hostent **result,
434 #if defined( HAVE_GETHOSTBYNAME_R )
436 # define NEED_SAFE_REALLOC 1
440 for(;buflen<BUFMAX;) {
441 if (safe_realloc( buf, buflen )==NULL)
444 #if (GETHOSTBYNAME_R_NARGS < 6)
445 *result=gethostbyname_r( name, resbuf, *buf, buflen, herrno_ptr );
446 r = (*result == NULL) ? -1 : 0;
448 r = gethostbyname_r( name, resbuf, *buf,
449 buflen, result, herrno_ptr );
452 Debug( LDAP_DEBUG_TRACE, "ldap_pvt_gethostbyname_a: host=%s, r=%d\n",
455 #ifdef NETDB_INTERNAL
457 (*herrno_ptr==NETDB_INTERNAL) &&
467 #elif defined( LDAP_R_COMPILE )
468 # define NEED_COPY_HOSTENT
473 LDAP_MUTEX_LOCK( &ldap_int_resolv_mutex );
475 he = gethostbyname( name );
478 *herrno_ptr = h_errno;
480 } else if (copy_hostent( resbuf, buf, he )<0) {
488 LDAP_MUTEX_UNLOCK( &ldap_int_resolv_mutex );
493 *result = gethostbyname( name );
499 *herrno_ptr = h_errno;
505 #if !defined( HAVE_GETNAMEINFO ) && !defined( HAVE_HSTRERROR )
507 hp_strerror( int err )
510 case HOST_NOT_FOUND: return _("Host not found (authoritative)");
511 case TRY_AGAIN: return _("Host not found (server fail?)");
512 case NO_RECOVERY: return _("Non-recoverable failure");
513 case NO_DATA: return _("No data of requested type");
514 #ifdef NETDB_INTERNAL
515 case NETDB_INTERNAL: return STRERROR( errno );
518 return _("Unknown resolver error");
522 int ldap_pvt_get_hname(
523 const struct sockaddr *sa,
530 #if defined( HAVE_GETNAMEINFO )
532 LDAP_MUTEX_LOCK( &ldap_int_resolv_mutex );
533 rc = getnameinfo( sa, len, name, namelen, NULL, 0, 0 );
534 LDAP_MUTEX_UNLOCK( &ldap_int_resolv_mutex );
535 if ( rc ) *err = (char *)AC_GAI_STRERROR( rc );
538 #else /* !HAVE_GETNAMEINFO */
541 struct hostent *hp = NULL;
542 #ifdef HAVE_GETHOSTBYADDR_R
544 int buflen=BUFSTART, h_errno;
549 if (sa->sa_family == AF_INET6) {
550 struct sockaddr_in6 *sin = (struct sockaddr_in6 *)sa;
551 addr = (char *)&sin->sin6_addr;
552 alen = sizeof(sin->sin6_addr);
555 if (sa->sa_family == AF_INET) {
556 struct sockaddr_in *sin = (struct sockaddr_in *)sa;
557 addr = (char *)&sin->sin_addr;
558 alen = sizeof(sin->sin_addr);
561 *err = (char *)HSTRERROR( rc );
564 #if defined( HAVE_GETHOSTBYADDR_R )
565 for(;buflen<BUFMAX;) {
566 if (safe_realloc( &buf, buflen )==NULL) {
567 *err = (char *)STRERROR( ENOMEM );
570 #if (GETHOSTBYADDR_R_NARGS < 8)
571 hp=gethostbyaddr_r( addr, alen, sa->sa_family,
572 &hb, buf, buflen, &h_errno );
573 rc = (hp == NULL) ? -1 : 0;
575 rc = gethostbyaddr_r( addr, alen, sa->sa_family,
579 #ifdef NETDB_INTERNAL
581 (h_errno==NETDB_INTERNAL) &&
591 strncpy( name, hp->h_name, namelen );
593 *err = (char *)HSTRERROR( h_errno );
596 #else /* HAVE_GETHOSTBYADDR_R */
598 LDAP_MUTEX_LOCK( &ldap_int_resolv_mutex );
599 hp = gethostbyaddr( addr, alen, sa->sa_family );
601 strncpy( name, hp->h_name, namelen );
605 *err = (char *)HSTRERROR( h_errno );
607 LDAP_MUTEX_UNLOCK( &ldap_int_resolv_mutex );
609 #endif /* !HAVE_GETHOSTBYADDR_R */
611 #endif /* !HAVE_GETNAMEINFO */
614 int ldap_pvt_gethostbyaddr_a(
618 struct hostent *resbuf,
620 struct hostent **result,
623 #if defined( HAVE_GETHOSTBYADDR_R )
625 # undef NEED_SAFE_REALLOC
626 # define NEED_SAFE_REALLOC
630 for(;buflen<BUFMAX;) {
631 if (safe_realloc( buf, buflen )==NULL)
633 #if (GETHOSTBYADDR_R_NARGS < 8)
634 *result=gethostbyaddr_r( addr, len, type,
635 resbuf, *buf, buflen, herrno_ptr );
636 r = (*result == NULL) ? -1 : 0;
638 r = gethostbyaddr_r( addr, len, type,
639 resbuf, *buf, buflen,
640 result, herrno_ptr );
643 #ifdef NETDB_INTERNAL
645 (*herrno_ptr==NETDB_INTERNAL) &&
655 #elif defined( LDAP_R_COMPILE )
656 # undef NEED_COPY_HOSTENT
657 # define NEED_COPY_HOSTENT
662 LDAP_MUTEX_LOCK( &ldap_int_resolv_mutex );
663 he = gethostbyaddr( addr, len, type );
666 *herrno_ptr = h_errno;
668 } else if (copy_hostent( resbuf, buf, he )<0) {
675 LDAP_MUTEX_UNLOCK( &ldap_int_resolv_mutex );
679 #else /* gethostbyaddr() */
681 *result = gethostbyaddr( addr, len, type );
690 * ldap_int_utils_init() should be called before any other function.
693 void ldap_int_utils_init( void )
700 #ifdef LDAP_R_COMPILE
701 #if !defined( USE_CTIME_R ) && !defined( HAVE_REENTRANT_FUNCTIONS )
702 ldap_pvt_thread_mutex_init( &ldap_int_ctime_mutex );
704 #if !defined( USE_GMTIME_R ) && !defined( USE_LOCALTIME_R )
705 ldap_pvt_thread_mutex_init( &ldap_int_gmtime_mutex );
707 ldap_pvt_thread_mutex_init( &ldap_int_resolv_mutex );
709 ldap_pvt_thread_mutex_init( &ldap_int_hostname_mutex );
711 ldap_pvt_thread_mutex_init( &ldap_int_gettime_mutex );
714 ldap_pvt_thread_mutex_init( &ldap_int_gssapi_mutex );
718 /* call other module init functions here... */
721 #if defined( NEED_COPY_HOSTENT )
722 # undef NEED_SAFE_REALLOC
723 #define NEED_SAFE_REALLOC
725 static char *cpy_aliases(
732 for( ; (*src) ; src++ ) {
733 len = strlen( *src ) + 1;
734 AC_MEMCPY( buf, *src, len );
742 static char *cpy_addresses(
749 for( ; (*src) ; src++ ) {
750 AC_MEMCPY( buf, *src, len );
758 static int copy_hostent(
761 struct hostent * src )
768 int total_alias_len=0;
770 int total_addr_len=0;
773 /* calculate the size needed for the buffer */
774 name_len = strlen( src->h_name ) + 1;
776 if( src->h_aliases != NULL ) {
777 for( p = src->h_aliases; (*p) != NULL; p++ ) {
778 total_alias_len += strlen( *p ) + 1;
783 if( src->h_addr_list != NULL ) {
784 for( p = src->h_addr_list; (*p) != NULL; p++ ) {
787 total_addr_len = n_addr * src->h_length;
790 total_len = (n_alias + n_addr + 2) * sizeof( char * ) +
791 total_addr_len + total_alias_len + name_len;
793 if (safe_realloc( buf, total_len )) {
795 tbuf = *buf + (n_alias + n_addr + 2) * sizeof( char * );
796 AC_MEMCPY( res, src, sizeof( struct hostent ) );
797 /* first the name... */
798 AC_MEMCPY( tbuf, src->h_name, name_len );
799 res->h_name = tbuf; tbuf+=name_len;
800 /* now the aliases */
802 if ( src->h_aliases != NULL ) {
803 tbuf = cpy_aliases( &tp, tbuf, src->h_aliases );
806 /* finally the addresses */
807 res->h_addr_list = tp;
808 if ( src->h_addr_list != NULL ) {
809 tbuf = cpy_addresses( &tp, tbuf, src->h_addr_list, src->h_length );
818 #if defined( NEED_SAFE_REALLOC )
819 static char *safe_realloc( char **buf, int len )
822 tmpbuf = LDAP_REALLOC( *buf, len );
830 char * ldap_pvt_get_fqdn( char *name )
833 char hostbuf[MAXHOSTNAMELEN+1];
834 struct hostent *hp, he_buf;
835 int rc, local_h_errno;
838 if( gethostname( hostbuf, MAXHOSTNAMELEN ) == 0 ) {
839 hostbuf[MAXHOSTNAMELEN] = '\0';
846 rc = ldap_pvt_gethostbyname_a( name,
847 &he_buf, &ha_buf, &hp, &local_h_errno );
849 if( rc < 0 || hp == NULL || hp->h_name == NULL ) {
850 fqdn = LDAP_STRDUP( name );
852 fqdn = LDAP_STRDUP( hp->h_name );
859 #if ( defined( HAVE_GETADDRINFO ) || defined( HAVE_GETNAMEINFO ) ) \
860 && !defined( HAVE_GAI_STRERROR )
861 char *ldap_pvt_gai_strerror (int code) {
866 #ifdef EAI_ADDRFAMILY
867 { EAI_ADDRFAMILY, N_("Address family for hostname not supported") },
869 { EAI_AGAIN, N_("Temporary failure in name resolution") },
870 { EAI_BADFLAGS, N_("Bad value for ai_flags") },
871 { EAI_FAIL, N_("Non-recoverable failure in name resolution") },
872 { EAI_FAMILY, N_("ai_family not supported") },
873 { EAI_MEMORY, N_("Memory allocation failure") },
875 { EAI_NODATA, N_("No address associated with hostname") },
877 { EAI_NONAME, N_("Name or service not known") },
878 { EAI_SERVICE, N_("Servname not supported for ai_socktype") },
879 { EAI_SOCKTYPE, N_("ai_socktype not supported") },
881 { EAI_SYSTEM, N_("System error") },
888 for ( i = 0; values[i].msg != NULL; i++ ) {
889 if ( values[i].code == code ) {
890 return (char *) _(values[i].msg);
894 return _("Unknown error");