2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2009 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;
62 # if (defined( HAVE_CTIME_R ) || defined( HAVE_REENTRANT_FUNCTIONS)) \
63 && defined( CTIME_R_NARGS )
66 static ldap_pvt_thread_mutex_t ldap_int_ctime_mutex;
69 /* USE_GMTIME_R and USE_LOCALTIME_R defined in ldap_pvt.h */
71 #if !defined( USE_GMTIME_R ) || !defined( USE_LOCALTIME_R )
72 /* we use the same mutex for gmtime(3) and localtime(3)
73 * because implementations may use the same buffer
74 * for both functions */
75 static ldap_pvt_thread_mutex_t ldap_int_gmtime_mutex;
78 # if defined(HAVE_GETHOSTBYNAME_R) && \
79 (GETHOSTBYNAME_R_NARGS < 5) || (6 < GETHOSTBYNAME_R_NARGS)
80 /* Don't know how to handle this version, pretend it's not there */
81 # undef HAVE_GETHOSTBYNAME_R
83 # if defined(HAVE_GETHOSTBYADDR_R) && \
84 (GETHOSTBYADDR_R_NARGS < 7) || (8 < GETHOSTBYADDR_R_NARGS)
85 /* Don't know how to handle this version, pretend it's not there */
86 # undef HAVE_GETHOSTBYADDR_R
88 #endif /* LDAP_R_COMPILE */
90 char *ldap_pvt_ctime( const time_t *tp, char *buf )
93 # if (CTIME_R_NARGS > 3) || (CTIME_R_NARGS < 2)
94 # error "CTIME_R_NARGS should be 2 or 3"
95 # elif CTIME_R_NARGS > 2 && defined(CTIME_R_RETURNS_INT)
96 return( ctime_r(tp,buf,26) < 0 ? 0 : buf );
97 # elif CTIME_R_NARGS > 2
98 return ctime_r(tp,buf,26);
100 return ctime_r(tp,buf);
105 # ifdef LDAP_R_COMPILE
106 ldap_pvt_thread_mutex_lock( &ldap_int_ctime_mutex );
109 AC_MEMCPY( buf, ctime(tp), 26 );
111 # ifdef LDAP_R_COMPILE
112 ldap_pvt_thread_mutex_unlock( &ldap_int_ctime_mutex );
121 ldap_pvt_gmtime_lock( void )
123 # ifndef LDAP_R_COMPILE
125 # else /* LDAP_R_COMPILE */
126 return ldap_pvt_thread_mutex_lock( &ldap_int_gmtime_mutex );
127 # endif /* LDAP_R_COMPILE */
131 ldap_pvt_gmtime_unlock( void )
133 # ifndef LDAP_R_COMPILE
135 # else /* LDAP_R_COMPILE */
136 return ldap_pvt_thread_mutex_unlock( &ldap_int_gmtime_mutex );
137 # endif /* LDAP_R_COMPILE */
141 ldap_pvt_gmtime( const time_t *timep, struct tm *result )
145 # ifdef LDAP_R_COMPILE
146 ldap_pvt_thread_mutex_lock( &ldap_int_gmtime_mutex );
147 # endif /* LDAP_R_COMPILE */
149 tm_ptr = gmtime( timep );
150 if ( tm_ptr == NULL ) {
157 # ifdef LDAP_R_COMPILE
158 ldap_pvt_thread_mutex_unlock( &ldap_int_gmtime_mutex );
159 # endif /* LDAP_R_COMPILE */
163 #endif /* !USE_GMTIME_R */
165 #ifndef USE_LOCALTIME_R
167 ldap_pvt_localtime( const time_t *timep, struct tm *result )
171 # ifdef LDAP_R_COMPILE
172 ldap_pvt_thread_mutex_lock( &ldap_int_gmtime_mutex );
173 # endif /* LDAP_R_COMPILE */
175 tm_ptr = localtime( timep );
176 if ( tm_ptr == NULL ) {
183 # ifdef LDAP_R_COMPILE
184 ldap_pvt_thread_mutex_unlock( &ldap_int_gmtime_mutex );
185 # endif /* LDAP_R_COMPILE */
189 #endif /* !USE_LOCALTIME_R */
191 /* return a broken out time, with microseconds
192 * Must be mutex-protected.
195 /* Windows SYSTEMTIME only has 10 millisecond resolution, so we
196 * also need to use a high resolution timer to get microseconds.
197 * This is pretty clunky.
200 ldap_pvt_gettime( struct lutil_tm *tm )
202 static LARGE_INTEGER cFreq;
203 static LARGE_INTEGER prevCount;
209 GetSystemTime( &st );
210 QueryPerformanceCounter( &count );
212 /* It shouldn't ever go backwards, but multiple CPUs might
213 * be able to hit in the same tick.
215 if ( count.QuadPart <= prevCount.QuadPart ) {
222 /* We assume Windows has at least a vague idea of
223 * when a second begins. So we align our microsecond count
224 * with the Windows millisecond count using this offset.
225 * We retain the submillisecond portion of our own count.
227 * Note - this also assumes that the relationship between
228 * the PerformanceCouunter and SystemTime stays constant;
229 * that assumption breaks if the SystemTime is adjusted by
230 * an external action.
232 if ( !cFreq.QuadPart ) {
235 QueryPerformanceFrequency( &cFreq );
237 /* just get sub-second portion of counter */
238 t = count.QuadPart % cFreq.QuadPart;
240 /* convert to microseconds */
242 usec = t / cFreq.QuadPart;
244 offset = usec - st.wMilliseconds * 1000;
249 /* convert to microseconds */
250 count.QuadPart %= cFreq.QuadPart;
251 count.QuadPart *= 1000000;
252 count.QuadPart /= cFreq.QuadPart;
253 count.QuadPart -= offset;
255 tm->tm_usec = count.QuadPart % 1000000;
256 if ( tm->tm_usec < 0 )
257 tm->tm_usec += 1000000;
259 /* any difference larger than microseconds is
260 * already reflected in st
263 tm->tm_sec = st.wSecond;
264 tm->tm_min = st.wMinute;
265 tm->tm_hour = st.wHour;
266 tm->tm_mday = st.wDay;
267 tm->tm_mon = st.wMonth - 1;
268 tm->tm_year = st.wYear - 1900;
272 ldap_pvt_gettime( struct lutil_tm *ltm )
275 static struct timeval prevTv;
281 gettimeofday( &tv, NULL );
284 if ( tv.tv_sec < prevTv.tv_sec
285 || ( tv.tv_sec == prevTv.tv_sec && tv.tv_usec == prevTv.tv_usec )) {
294 ldap_pvt_gmtime( &t, &tm );
296 ltm->tm_sec = tm.tm_sec;
297 ltm->tm_min = tm.tm_min;
298 ltm->tm_hour = tm.tm_hour;
299 ltm->tm_mday = tm.tm_mday;
300 ltm->tm_mon = tm.tm_mon;
301 ltm->tm_year = tm.tm_year;
302 ltm->tm_usec = tv.tv_usec;
307 ldap_pvt_csnstr(char *buf, size_t len, unsigned int replica, unsigned int mod)
312 ldap_pvt_gettime( &tm );
314 n = snprintf( buf, len,
315 "%4d%02d%02d%02d%02d%02d.%06dZ#%06x#%03x#%06x",
316 tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, tm.tm_hour,
317 tm.tm_min, tm.tm_sec, tm.tm_usec, tm.tm_usub, replica, mod );
319 if( n < 0 ) return 0;
320 return ( (size_t) n < len ) ? n : 0;
323 #define BUFSTART (1024-32)
324 #define BUFMAX (32*1024-32)
326 #if defined(LDAP_R_COMPILE)
327 static char *safe_realloc( char **buf, int len );
329 #if !(defined(HAVE_GETHOSTBYNAME_R) && defined(HAVE_GETHOSTBYADDR_R))
330 static int copy_hostent( struct hostent *res,
331 char **buf, struct hostent * src );
335 int ldap_pvt_gethostbyname_a(
337 struct hostent *resbuf,
339 struct hostent **result,
342 #if defined( HAVE_GETHOSTBYNAME_R )
344 # define NEED_SAFE_REALLOC 1
348 for(;buflen<BUFMAX;) {
349 if (safe_realloc( buf, buflen )==NULL)
352 #if (GETHOSTBYNAME_R_NARGS < 6)
353 *result=gethostbyname_r( name, resbuf, *buf, buflen, herrno_ptr );
354 r = (*result == NULL) ? -1 : 0;
356 r = gethostbyname_r( name, resbuf, *buf,
357 buflen, result, herrno_ptr );
360 Debug( LDAP_DEBUG_TRACE, "ldap_pvt_gethostbyname_a: host=%s, r=%d\n",
363 #ifdef NETDB_INTERNAL
365 (*herrno_ptr==NETDB_INTERNAL) &&
375 #elif defined( LDAP_R_COMPILE )
376 # define NEED_COPY_HOSTENT
381 ldap_pvt_thread_mutex_lock( &ldap_int_resolv_mutex );
383 he = gethostbyname( name );
386 *herrno_ptr = h_errno;
388 } else if (copy_hostent( resbuf, buf, he )<0) {
396 ldap_pvt_thread_mutex_unlock( &ldap_int_resolv_mutex );
401 *result = gethostbyname( name );
407 *herrno_ptr = h_errno;
413 #if !defined( HAVE_GETNAMEINFO ) && !defined( HAVE_HSTRERROR )
415 hp_strerror( int err )
418 case HOST_NOT_FOUND: return _("Host not found (authoritative)");
419 case TRY_AGAIN: return _("Host not found (server fail?)");
420 case NO_RECOVERY: return _("Non-recoverable failure");
421 case NO_DATA: return _("No data of requested type");
422 #ifdef NETDB_INTERNAL
423 case NETDB_INTERNAL: return STRERROR( errno );
426 return _("Unknown resolver error");
430 int ldap_pvt_get_hname(
431 const struct sockaddr *sa,
438 #if defined( HAVE_GETNAMEINFO )
440 #if defined( LDAP_R_COMPILE )
441 ldap_pvt_thread_mutex_lock( &ldap_int_resolv_mutex );
443 rc = getnameinfo( sa, len, name, namelen, NULL, 0, 0 );
444 #if defined( LDAP_R_COMPILE )
445 ldap_pvt_thread_mutex_unlock( &ldap_int_resolv_mutex );
447 if ( rc ) *err = (char *)AC_GAI_STRERROR( rc );
450 #else /* !HAVE_GETNAMEINFO */
453 struct hostent *hp = NULL;
454 #ifdef HAVE_GETHOSTBYADDR_R
456 int buflen=BUFSTART, h_errno;
461 if (sa->sa_family == AF_INET6) {
462 struct sockaddr_in6 *sin = (struct sockaddr_in6 *)sa;
463 addr = (char *)&sin->sin6_addr;
464 alen = sizeof(sin->sin6_addr);
467 if (sa->sa_family == AF_INET) {
468 struct sockaddr_in *sin = (struct sockaddr_in *)sa;
469 addr = (char *)&sin->sin_addr;
470 alen = sizeof(sin->sin_addr);
473 *err = (char *)HSTRERROR( rc );
476 #if defined( HAVE_GETHOSTBYADDR_R )
477 for(;buflen<BUFMAX;) {
478 if (safe_realloc( &buf, buflen )==NULL) {
479 *err = (char *)STRERROR( ENOMEM );
482 #if (GETHOSTBYADDR_R_NARGS < 8)
483 hp=gethostbyaddr_r( addr, alen, sa->sa_family,
484 &hb, buf, buflen, &h_errno );
485 rc = (hp == NULL) ? -1 : 0;
487 rc = gethostbyaddr_r( addr, alen, sa->sa_family,
491 #ifdef NETDB_INTERNAL
493 (h_errno==NETDB_INTERNAL) &&
503 strncpy( name, hp->h_name, namelen );
505 *err = (char *)HSTRERROR( h_errno );
508 #else /* HAVE_GETHOSTBYADDR_R */
510 #if defined( LDAP_R_COMPILE )
511 ldap_pvt_thread_mutex_lock( &ldap_int_resolv_mutex );
513 hp = gethostbyaddr( addr, alen, sa->sa_family );
515 strncpy( name, hp->h_name, namelen );
519 *err = (char *)HSTRERROR( h_errno );
521 #if defined( LDAP_R_COMPILE )
522 ldap_pvt_thread_mutex_unlock( &ldap_int_resolv_mutex );
525 #endif /* !HAVE_GETHOSTBYADDR_R */
527 #endif /* !HAVE_GETNAMEINFO */
530 int ldap_pvt_gethostbyaddr_a(
534 struct hostent *resbuf,
536 struct hostent **result,
539 #if defined( HAVE_GETHOSTBYADDR_R )
541 # undef NEED_SAFE_REALLOC
542 # define NEED_SAFE_REALLOC
546 for(;buflen<BUFMAX;) {
547 if (safe_realloc( buf, buflen )==NULL)
549 #if (GETHOSTBYADDR_R_NARGS < 8)
550 *result=gethostbyaddr_r( addr, len, type,
551 resbuf, *buf, buflen, herrno_ptr );
552 r = (*result == NULL) ? -1 : 0;
554 r = gethostbyaddr_r( addr, len, type,
555 resbuf, *buf, buflen,
556 result, herrno_ptr );
559 #ifdef NETDB_INTERNAL
561 (*herrno_ptr==NETDB_INTERNAL) &&
571 #elif defined( LDAP_R_COMPILE )
572 # undef NEED_COPY_HOSTENT
573 # define NEED_COPY_HOSTENT
578 ldap_pvt_thread_mutex_lock( &ldap_int_resolv_mutex );
580 he = gethostbyaddr( addr, len, type );
583 *herrno_ptr = h_errno;
585 } else if (copy_hostent( resbuf, buf, he )<0) {
593 ldap_pvt_thread_mutex_unlock( &ldap_int_resolv_mutex );
597 #else /* gethostbyaddr() */
599 *result = gethostbyaddr( addr, len, type );
608 * ldap_int_utils_init() should be called before any other function.
611 void ldap_int_utils_init( void )
618 #ifdef LDAP_R_COMPILE
619 #if !defined( USE_CTIME_R ) && !defined( HAVE_REENTRANT_FUNCTIONS )
620 ldap_pvt_thread_mutex_init( &ldap_int_ctime_mutex );
622 #if !defined( USE_GMTIME_R ) && !defined( USE_LOCALTIME_R )
623 ldap_pvt_thread_mutex_init( &ldap_int_gmtime_mutex );
625 ldap_pvt_thread_mutex_init( &ldap_int_resolv_mutex );
627 #ifdef HAVE_CYRUS_SASL
628 ldap_pvt_thread_mutex_init( &ldap_int_sasl_mutex );
631 ldap_pvt_thread_mutex_init( &ldap_int_gssapi_mutex );
635 /* call other module init functions here... */
638 #if defined( NEED_COPY_HOSTENT )
639 # undef NEED_SAFE_REALLOC
640 #define NEED_SAFE_REALLOC
642 static char *cpy_aliases(
649 for( ; (*src) ; src++ ) {
650 len = strlen( *src ) + 1;
651 AC_MEMCPY( buf, *src, len );
659 static char *cpy_addresses(
666 for( ; (*src) ; src++ ) {
667 AC_MEMCPY( buf, *src, len );
675 static int copy_hostent(
678 struct hostent * src )
685 int total_alias_len=0;
687 int total_addr_len=0;
690 /* calculate the size needed for the buffer */
691 name_len = strlen( src->h_name ) + 1;
693 if( src->h_aliases != NULL ) {
694 for( p = src->h_aliases; (*p) != NULL; p++ ) {
695 total_alias_len += strlen( *p ) + 1;
700 if( src->h_addr_list != NULL ) {
701 for( p = src->h_addr_list; (*p) != NULL; p++ ) {
704 total_addr_len = n_addr * src->h_length;
707 total_len = (n_alias + n_addr + 2) * sizeof( char * ) +
708 total_addr_len + total_alias_len + name_len;
710 if (safe_realloc( buf, total_len )) {
712 tbuf = *buf + (n_alias + n_addr + 2) * sizeof( char * );
713 AC_MEMCPY( res, src, sizeof( struct hostent ) );
714 /* first the name... */
715 AC_MEMCPY( tbuf, src->h_name, name_len );
716 res->h_name = tbuf; tbuf+=name_len;
717 /* now the aliases */
719 if ( src->h_aliases != NULL ) {
720 tbuf = cpy_aliases( &tp, tbuf, src->h_aliases );
723 /* finally the addresses */
724 res->h_addr_list = tp;
725 if ( src->h_addr_list != NULL ) {
726 tbuf = cpy_addresses( &tp, tbuf, src->h_addr_list, src->h_length );
735 #if defined( NEED_SAFE_REALLOC )
736 static char *safe_realloc( char **buf, int len )
739 tmpbuf = LDAP_REALLOC( *buf, len );
747 char * ldap_pvt_get_fqdn( char *name )
750 char hostbuf[MAXHOSTNAMELEN+1];
751 struct hostent *hp, he_buf;
752 int rc, local_h_errno;
755 if( gethostname( hostbuf, MAXHOSTNAMELEN ) == 0 ) {
756 hostbuf[MAXHOSTNAMELEN] = '\0';
763 rc = ldap_pvt_gethostbyname_a( name,
764 &he_buf, &ha_buf, &hp, &local_h_errno );
766 if( rc < 0 || hp == NULL || hp->h_name == NULL ) {
767 fqdn = LDAP_STRDUP( name );
769 fqdn = LDAP_STRDUP( hp->h_name );
776 #if ( defined( HAVE_GETADDRINFO ) || defined( HAVE_GETNAMEINFO ) ) \
777 && !defined( HAVE_GAI_STRERROR )
778 char *ldap_pvt_gai_strerror (int code) {
783 #ifdef EAI_ADDRFAMILY
784 { EAI_ADDRFAMILY, N_("Address family for hostname not supported") },
786 { EAI_AGAIN, N_("Temporary failure in name resolution") },
787 { EAI_BADFLAGS, N_("Bad value for ai_flags") },
788 { EAI_FAIL, N_("Non-recoverable failure in name resolution") },
789 { EAI_FAMILY, N_("ai_family not supported") },
790 { EAI_MEMORY, N_("Memory allocation failure") },
792 { EAI_NODATA, N_("No address associated with hostname") },
794 { EAI_NONAME, N_("Name or service not known") },
795 { EAI_SERVICE, N_("Servname not supported for ai_socktype") },
796 { EAI_SOCKTYPE, N_("ai_socktype not supported") },
797 { EAI_SYSTEM, N_("System error") },
803 for ( i = 0; values[i].msg != NULL; i++ ) {
804 if ( values[i].code == code ) {
805 return (char *) _(values[i].msg);
809 return _("Unknown error");