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 );
119 #if !defined( USE_GMTIME_R ) || !defined( USE_LOCALTIME_R )
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 */
139 #endif /* !USE_GMTIME_R || !USE_LOCALTIME_R */
143 ldap_pvt_gmtime( const time_t *timep, struct tm *result )
147 # ifdef LDAP_R_COMPILE
148 ldap_pvt_thread_mutex_lock( &ldap_int_gmtime_mutex );
149 # endif /* LDAP_R_COMPILE */
151 tm_ptr = gmtime( timep );
152 if ( tm_ptr == NULL ) {
159 # ifdef LDAP_R_COMPILE
160 ldap_pvt_thread_mutex_unlock( &ldap_int_gmtime_mutex );
161 # endif /* LDAP_R_COMPILE */
165 #endif /* !USE_GMTIME_R */
167 #ifndef USE_LOCALTIME_R
169 ldap_pvt_localtime( const time_t *timep, struct tm *result )
173 # ifdef LDAP_R_COMPILE
174 ldap_pvt_thread_mutex_lock( &ldap_int_gmtime_mutex );
175 # endif /* LDAP_R_COMPILE */
177 tm_ptr = localtime( timep );
178 if ( tm_ptr == NULL ) {
185 # ifdef LDAP_R_COMPILE
186 ldap_pvt_thread_mutex_unlock( &ldap_int_gmtime_mutex );
187 # endif /* LDAP_R_COMPILE */
191 #endif /* !USE_LOCALTIME_R */
193 /* return a broken out time, with microseconds
194 * Must be mutex-protected.
197 /* Windows SYSTEMTIME only has 10 millisecond resolution, so we
198 * also need to use a high resolution timer to get microseconds.
199 * This is pretty clunky.
202 ldap_pvt_gettime( struct lutil_tm *tm )
204 static LARGE_INTEGER cFreq;
205 static LARGE_INTEGER prevCount;
211 GetSystemTime( &st );
212 QueryPerformanceCounter( &count );
214 /* It shouldn't ever go backwards, but multiple CPUs might
215 * be able to hit in the same tick.
217 if ( count.QuadPart <= prevCount.QuadPart ) {
224 /* We assume Windows has at least a vague idea of
225 * when a second begins. So we align our microsecond count
226 * with the Windows millisecond count using this offset.
227 * We retain the submillisecond portion of our own count.
229 * Note - this also assumes that the relationship between
230 * the PerformanceCouunter and SystemTime stays constant;
231 * that assumption breaks if the SystemTime is adjusted by
232 * an external action.
234 if ( !cFreq.QuadPart ) {
237 QueryPerformanceFrequency( &cFreq );
239 /* just get sub-second portion of counter */
240 t = count.QuadPart % cFreq.QuadPart;
242 /* convert to microseconds */
244 usec = t / cFreq.QuadPart;
246 offset = usec - st.wMilliseconds * 1000;
251 /* convert to microseconds */
252 count.QuadPart %= cFreq.QuadPart;
253 count.QuadPart *= 1000000;
254 count.QuadPart /= cFreq.QuadPart;
255 count.QuadPart -= offset;
257 tm->tm_usec = count.QuadPart % 1000000;
258 if ( tm->tm_usec < 0 )
259 tm->tm_usec += 1000000;
261 /* any difference larger than microseconds is
262 * already reflected in st
265 tm->tm_sec = st.wSecond;
266 tm->tm_min = st.wMinute;
267 tm->tm_hour = st.wHour;
268 tm->tm_mday = st.wDay;
269 tm->tm_mon = st.wMonth - 1;
270 tm->tm_year = st.wYear - 1900;
274 ldap_pvt_gettime( struct lutil_tm *ltm )
277 static struct timeval prevTv;
283 gettimeofday( &tv, NULL );
286 if ( tv.tv_sec < prevTv.tv_sec
287 || ( tv.tv_sec == prevTv.tv_sec && tv.tv_usec == prevTv.tv_usec )) {
296 ldap_pvt_gmtime( &t, &tm );
298 ltm->tm_sec = tm.tm_sec;
299 ltm->tm_min = tm.tm_min;
300 ltm->tm_hour = tm.tm_hour;
301 ltm->tm_mday = tm.tm_mday;
302 ltm->tm_mon = tm.tm_mon;
303 ltm->tm_year = tm.tm_year;
304 ltm->tm_usec = tv.tv_usec;
309 ldap_pvt_csnstr(char *buf, size_t len, unsigned int replica, unsigned int mod)
314 ldap_pvt_gettime( &tm );
316 n = snprintf( buf, len,
317 "%4d%02d%02d%02d%02d%02d.%06dZ#%06x#%03x#%06x",
318 tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, tm.tm_hour,
319 tm.tm_min, tm.tm_sec, tm.tm_usec, tm.tm_usub, replica, mod );
321 if( n < 0 ) return 0;
322 return ( (size_t) n < len ) ? n : 0;
325 #define BUFSTART (1024-32)
326 #define BUFMAX (32*1024-32)
328 #if defined(LDAP_R_COMPILE)
329 static char *safe_realloc( char **buf, int len );
331 #if !(defined(HAVE_GETHOSTBYNAME_R) && defined(HAVE_GETHOSTBYADDR_R))
332 static int copy_hostent( struct hostent *res,
333 char **buf, struct hostent * src );
337 int ldap_pvt_gethostbyname_a(
339 struct hostent *resbuf,
341 struct hostent **result,
344 #if defined( HAVE_GETHOSTBYNAME_R )
346 # define NEED_SAFE_REALLOC 1
350 for(;buflen<BUFMAX;) {
351 if (safe_realloc( buf, buflen )==NULL)
354 #if (GETHOSTBYNAME_R_NARGS < 6)
355 *result=gethostbyname_r( name, resbuf, *buf, buflen, herrno_ptr );
356 r = (*result == NULL) ? -1 : 0;
358 r = gethostbyname_r( name, resbuf, *buf,
359 buflen, result, herrno_ptr );
362 Debug( LDAP_DEBUG_TRACE, "ldap_pvt_gethostbyname_a: host=%s, r=%d\n",
365 #ifdef NETDB_INTERNAL
367 (*herrno_ptr==NETDB_INTERNAL) &&
377 #elif defined( LDAP_R_COMPILE )
378 # define NEED_COPY_HOSTENT
383 ldap_pvt_thread_mutex_lock( &ldap_int_resolv_mutex );
385 he = gethostbyname( name );
388 *herrno_ptr = h_errno;
390 } else if (copy_hostent( resbuf, buf, he )<0) {
398 ldap_pvt_thread_mutex_unlock( &ldap_int_resolv_mutex );
403 *result = gethostbyname( name );
409 *herrno_ptr = h_errno;
415 #if !defined( HAVE_GETNAMEINFO ) && !defined( HAVE_HSTRERROR )
417 hp_strerror( int err )
420 case HOST_NOT_FOUND: return _("Host not found (authoritative)");
421 case TRY_AGAIN: return _("Host not found (server fail?)");
422 case NO_RECOVERY: return _("Non-recoverable failure");
423 case NO_DATA: return _("No data of requested type");
424 #ifdef NETDB_INTERNAL
425 case NETDB_INTERNAL: return STRERROR( errno );
428 return _("Unknown resolver error");
432 int ldap_pvt_get_hname(
433 const struct sockaddr *sa,
440 #if defined( HAVE_GETNAMEINFO )
442 #if defined( LDAP_R_COMPILE )
443 ldap_pvt_thread_mutex_lock( &ldap_int_resolv_mutex );
445 rc = getnameinfo( sa, len, name, namelen, NULL, 0, 0 );
446 #if defined( LDAP_R_COMPILE )
447 ldap_pvt_thread_mutex_unlock( &ldap_int_resolv_mutex );
449 if ( rc ) *err = (char *)AC_GAI_STRERROR( rc );
452 #else /* !HAVE_GETNAMEINFO */
455 struct hostent *hp = NULL;
456 #ifdef HAVE_GETHOSTBYADDR_R
458 int buflen=BUFSTART, h_errno;
463 if (sa->sa_family == AF_INET6) {
464 struct sockaddr_in6 *sin = (struct sockaddr_in6 *)sa;
465 addr = (char *)&sin->sin6_addr;
466 alen = sizeof(sin->sin6_addr);
469 if (sa->sa_family == AF_INET) {
470 struct sockaddr_in *sin = (struct sockaddr_in *)sa;
471 addr = (char *)&sin->sin_addr;
472 alen = sizeof(sin->sin_addr);
475 *err = (char *)HSTRERROR( rc );
478 #if defined( HAVE_GETHOSTBYADDR_R )
479 for(;buflen<BUFMAX;) {
480 if (safe_realloc( &buf, buflen )==NULL) {
481 *err = (char *)STRERROR( ENOMEM );
484 #if (GETHOSTBYADDR_R_NARGS < 8)
485 hp=gethostbyaddr_r( addr, alen, sa->sa_family,
486 &hb, buf, buflen, &h_errno );
487 rc = (hp == NULL) ? -1 : 0;
489 rc = gethostbyaddr_r( addr, alen, sa->sa_family,
493 #ifdef NETDB_INTERNAL
495 (h_errno==NETDB_INTERNAL) &&
505 strncpy( name, hp->h_name, namelen );
507 *err = (char *)HSTRERROR( h_errno );
510 #else /* HAVE_GETHOSTBYADDR_R */
512 #if defined( LDAP_R_COMPILE )
513 ldap_pvt_thread_mutex_lock( &ldap_int_resolv_mutex );
515 hp = gethostbyaddr( addr, alen, sa->sa_family );
517 strncpy( name, hp->h_name, namelen );
521 *err = (char *)HSTRERROR( h_errno );
523 #if defined( LDAP_R_COMPILE )
524 ldap_pvt_thread_mutex_unlock( &ldap_int_resolv_mutex );
527 #endif /* !HAVE_GETHOSTBYADDR_R */
529 #endif /* !HAVE_GETNAMEINFO */
532 int ldap_pvt_gethostbyaddr_a(
536 struct hostent *resbuf,
538 struct hostent **result,
541 #if defined( HAVE_GETHOSTBYADDR_R )
543 # undef NEED_SAFE_REALLOC
544 # define NEED_SAFE_REALLOC
548 for(;buflen<BUFMAX;) {
549 if (safe_realloc( buf, buflen )==NULL)
551 #if (GETHOSTBYADDR_R_NARGS < 8)
552 *result=gethostbyaddr_r( addr, len, type,
553 resbuf, *buf, buflen, herrno_ptr );
554 r = (*result == NULL) ? -1 : 0;
556 r = gethostbyaddr_r( addr, len, type,
557 resbuf, *buf, buflen,
558 result, herrno_ptr );
561 #ifdef NETDB_INTERNAL
563 (*herrno_ptr==NETDB_INTERNAL) &&
573 #elif defined( LDAP_R_COMPILE )
574 # undef NEED_COPY_HOSTENT
575 # define NEED_COPY_HOSTENT
580 ldap_pvt_thread_mutex_lock( &ldap_int_resolv_mutex );
582 he = gethostbyaddr( addr, len, type );
585 *herrno_ptr = h_errno;
587 } else if (copy_hostent( resbuf, buf, he )<0) {
595 ldap_pvt_thread_mutex_unlock( &ldap_int_resolv_mutex );
599 #else /* gethostbyaddr() */
601 *result = gethostbyaddr( addr, len, type );
610 * ldap_int_utils_init() should be called before any other function.
613 void ldap_int_utils_init( void )
620 #ifdef LDAP_R_COMPILE
621 #if !defined( USE_CTIME_R ) && !defined( HAVE_REENTRANT_FUNCTIONS )
622 ldap_pvt_thread_mutex_init( &ldap_int_ctime_mutex );
624 #if !defined( USE_GMTIME_R ) && !defined( USE_LOCALTIME_R )
625 ldap_pvt_thread_mutex_init( &ldap_int_gmtime_mutex );
627 ldap_pvt_thread_mutex_init( &ldap_int_resolv_mutex );
629 #ifdef HAVE_CYRUS_SASL
630 ldap_pvt_thread_mutex_init( &ldap_int_sasl_mutex );
633 ldap_pvt_thread_mutex_init( &ldap_int_gssapi_mutex );
637 /* call other module init functions here... */
640 #if defined( NEED_COPY_HOSTENT )
641 # undef NEED_SAFE_REALLOC
642 #define NEED_SAFE_REALLOC
644 static char *cpy_aliases(
651 for( ; (*src) ; src++ ) {
652 len = strlen( *src ) + 1;
653 AC_MEMCPY( buf, *src, len );
661 static char *cpy_addresses(
668 for( ; (*src) ; src++ ) {
669 AC_MEMCPY( buf, *src, len );
677 static int copy_hostent(
680 struct hostent * src )
687 int total_alias_len=0;
689 int total_addr_len=0;
692 /* calculate the size needed for the buffer */
693 name_len = strlen( src->h_name ) + 1;
695 if( src->h_aliases != NULL ) {
696 for( p = src->h_aliases; (*p) != NULL; p++ ) {
697 total_alias_len += strlen( *p ) + 1;
702 if( src->h_addr_list != NULL ) {
703 for( p = src->h_addr_list; (*p) != NULL; p++ ) {
706 total_addr_len = n_addr * src->h_length;
709 total_len = (n_alias + n_addr + 2) * sizeof( char * ) +
710 total_addr_len + total_alias_len + name_len;
712 if (safe_realloc( buf, total_len )) {
714 tbuf = *buf + (n_alias + n_addr + 2) * sizeof( char * );
715 AC_MEMCPY( res, src, sizeof( struct hostent ) );
716 /* first the name... */
717 AC_MEMCPY( tbuf, src->h_name, name_len );
718 res->h_name = tbuf; tbuf+=name_len;
719 /* now the aliases */
721 if ( src->h_aliases != NULL ) {
722 tbuf = cpy_aliases( &tp, tbuf, src->h_aliases );
725 /* finally the addresses */
726 res->h_addr_list = tp;
727 if ( src->h_addr_list != NULL ) {
728 tbuf = cpy_addresses( &tp, tbuf, src->h_addr_list, src->h_length );
737 #if defined( NEED_SAFE_REALLOC )
738 static char *safe_realloc( char **buf, int len )
741 tmpbuf = LDAP_REALLOC( *buf, len );
749 char * ldap_pvt_get_fqdn( char *name )
752 char hostbuf[MAXHOSTNAMELEN+1];
753 struct hostent *hp, he_buf;
754 int rc, local_h_errno;
757 if( gethostname( hostbuf, MAXHOSTNAMELEN ) == 0 ) {
758 hostbuf[MAXHOSTNAMELEN] = '\0';
765 rc = ldap_pvt_gethostbyname_a( name,
766 &he_buf, &ha_buf, &hp, &local_h_errno );
768 if( rc < 0 || hp == NULL || hp->h_name == NULL ) {
769 fqdn = LDAP_STRDUP( name );
771 fqdn = LDAP_STRDUP( hp->h_name );
778 #if ( defined( HAVE_GETADDRINFO ) || defined( HAVE_GETNAMEINFO ) ) \
779 && !defined( HAVE_GAI_STRERROR )
780 char *ldap_pvt_gai_strerror (int code) {
785 #ifdef EAI_ADDRFAMILY
786 { EAI_ADDRFAMILY, N_("Address family for hostname not supported") },
788 { EAI_AGAIN, N_("Temporary failure in name resolution") },
789 { EAI_BADFLAGS, N_("Bad value for ai_flags") },
790 { EAI_FAIL, N_("Non-recoverable failure in name resolution") },
791 { EAI_FAMILY, N_("ai_family not supported") },
792 { EAI_MEMORY, N_("Memory allocation failure") },
794 { EAI_NODATA, N_("No address associated with hostname") },
796 { EAI_NONAME, N_("Name or service not known") },
797 { EAI_SERVICE, N_("Servname not supported for ai_socktype") },
798 { EAI_SOCKTYPE, N_("ai_socktype not supported") },
799 { EAI_SYSTEM, N_("System error") },
805 for ( i = 0; values[i].msg != NULL; i++ ) {
806 if ( values[i].code == code ) {
807 return (char *) _(values[i].msg);
811 return _("Unknown error");