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 ) {
154 # ifdef LDAP_R_COMPILE
155 ldap_pvt_thread_mutex_unlock( &ldap_int_gmtime_mutex );
156 # endif /* LDAP_R_COMPILE */
160 #endif /* !USE_GMTIME_R */
162 #ifndef USE_LOCALTIME_R
164 ldap_pvt_localtime( const time_t *timep, struct tm *result )
168 # ifdef LDAP_R_COMPILE
169 ldap_pvt_thread_mutex_lock( &ldap_int_gmtime_mutex );
170 # endif /* LDAP_R_COMPILE */
172 tm_ptr = localtime( timep );
173 if ( tm_ptr != NULL ) {
177 # ifdef LDAP_R_COMPILE
178 ldap_pvt_thread_mutex_unlock( &ldap_int_gmtime_mutex );
179 # endif /* LDAP_R_COMPILE */
183 #endif /* !USE_LOCALTIME_R */
185 /* return a broken out time, with microseconds
186 * Must be mutex-protected.
189 /* Windows SYSTEMTIME only has 10 millisecond resolution, so we
190 * also need to use a high resolution timer to get microseconds.
191 * This is pretty clunky.
194 ldap_pvt_gettime( struct lutil_tm *tm )
196 static LARGE_INTEGER cFreq;
197 static LARGE_INTEGER prevCount;
203 GetSystemTime( &st );
204 QueryPerformanceCounter( &count );
206 /* It shouldn't ever go backwards, but multiple CPUs might
207 * be able to hit in the same tick.
209 if ( count.QuadPart <= prevCount.QuadPart ) {
216 /* We assume Windows has at least a vague idea of
217 * when a second begins. So we align our microsecond count
218 * with the Windows millisecond count using this offset.
219 * We retain the submillisecond portion of our own count.
221 * Note - this also assumes that the relationship between
222 * the PerformanceCouunter and SystemTime stays constant;
223 * that assumption breaks if the SystemTime is adjusted by
224 * an external action.
226 if ( !cFreq.QuadPart ) {
229 QueryPerformanceFrequency( &cFreq );
231 /* just get sub-second portion of counter */
232 t = count.QuadPart % cFreq.QuadPart;
234 /* convert to microseconds */
236 usec = t / cFreq.QuadPart;
238 offset = usec - st.wMilliseconds * 1000;
243 /* convert to microseconds */
244 count.QuadPart %= cFreq.QuadPart;
245 count.QuadPart *= 1000000;
246 count.QuadPart /= cFreq.QuadPart;
247 count.QuadPart -= offset;
249 tm->tm_usec = count.QuadPart % 1000000;
250 if ( tm->tm_usec < 0 )
251 tm->tm_usec += 1000000;
253 /* any difference larger than microseconds is
254 * already reflected in st
257 tm->tm_sec = st.wSecond;
258 tm->tm_min = st.wMinute;
259 tm->tm_hour = st.wHour;
260 tm->tm_mday = st.wDay;
261 tm->tm_mon = st.wMonth - 1;
262 tm->tm_year = st.wYear - 1900;
266 ldap_pvt_gettime( struct lutil_tm *ltm )
269 static struct timeval prevTv;
275 gettimeofday( &tv, NULL );
278 if ( tv.tv_sec < prevTv.tv_sec
279 || ( tv.tv_sec == prevTv.tv_sec && tv.tv_usec == prevTv.tv_usec )) {
288 ldap_pvt_gmtime( &t, &tm );
290 ltm->tm_sec = tm.tm_sec;
291 ltm->tm_min = tm.tm_min;
292 ltm->tm_hour = tm.tm_hour;
293 ltm->tm_mday = tm.tm_mday;
294 ltm->tm_mon = tm.tm_mon;
295 ltm->tm_year = tm.tm_year;
296 ltm->tm_usec = tv.tv_usec;
301 ldap_pvt_csnstr(char *buf, size_t len, unsigned int replica, unsigned int mod)
306 ldap_pvt_gettime( &tm );
308 n = snprintf( buf, len,
309 "%4d%02d%02d%02d%02d%02d.%06dZ#%06x#%03x#%06x",
310 tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, tm.tm_hour,
311 tm.tm_min, tm.tm_sec, tm.tm_usec, tm.tm_usub, replica, mod );
313 if( n < 0 ) return 0;
314 return ( (size_t) n < len ) ? n : 0;
317 #define BUFSTART (1024-32)
318 #define BUFMAX (32*1024-32)
320 #if defined(LDAP_R_COMPILE)
321 static char *safe_realloc( char **buf, int len );
323 #if !(defined(HAVE_GETHOSTBYNAME_R) && defined(HAVE_GETHOSTBYADDR_R))
324 static int copy_hostent( struct hostent *res,
325 char **buf, struct hostent * src );
329 int ldap_pvt_gethostbyname_a(
331 struct hostent *resbuf,
333 struct hostent **result,
336 #if defined( HAVE_GETHOSTBYNAME_R )
338 # define NEED_SAFE_REALLOC 1
342 for(;buflen<BUFMAX;) {
343 if (safe_realloc( buf, buflen )==NULL)
346 #if (GETHOSTBYNAME_R_NARGS < 6)
347 *result=gethostbyname_r( name, resbuf, *buf, buflen, herrno_ptr );
348 r = (*result == NULL) ? -1 : 0;
350 r = gethostbyname_r( name, resbuf, *buf,
351 buflen, result, herrno_ptr );
354 Debug( LDAP_DEBUG_TRACE, "ldap_pvt_gethostbyname_a: host=%s, r=%d\n",
357 #ifdef NETDB_INTERNAL
359 (*herrno_ptr==NETDB_INTERNAL) &&
369 #elif defined( LDAP_R_COMPILE )
370 # define NEED_COPY_HOSTENT
375 ldap_pvt_thread_mutex_lock( &ldap_int_resolv_mutex );
377 he = gethostbyname( name );
380 *herrno_ptr = h_errno;
382 } else if (copy_hostent( resbuf, buf, he )<0) {
390 ldap_pvt_thread_mutex_unlock( &ldap_int_resolv_mutex );
395 *result = gethostbyname( name );
401 *herrno_ptr = h_errno;
407 #if !defined( HAVE_GETNAMEINFO ) && !defined( HAVE_HSTRERROR )
409 hp_strerror( int err )
412 case HOST_NOT_FOUND: return _("Host not found (authoritative)");
413 case TRY_AGAIN: return _("Host not found (server fail?)");
414 case NO_RECOVERY: return _("Non-recoverable failure");
415 case NO_DATA: return _("No data of requested type");
416 #ifdef NETDB_INTERNAL
417 case NETDB_INTERNAL: return STRERROR( errno );
420 return _("Unknown resolver error");
424 int ldap_pvt_get_hname(
425 const struct sockaddr *sa,
432 #if defined( HAVE_GETNAMEINFO )
434 #if defined( LDAP_R_COMPILE )
435 ldap_pvt_thread_mutex_lock( &ldap_int_resolv_mutex );
437 rc = getnameinfo( sa, len, name, namelen, NULL, 0, 0 );
438 #if defined( LDAP_R_COMPILE )
439 ldap_pvt_thread_mutex_unlock( &ldap_int_resolv_mutex );
441 if ( rc ) *err = (char *)AC_GAI_STRERROR( rc );
444 #else /* !HAVE_GETNAMEINFO */
447 struct hostent *hp = NULL;
448 #ifdef HAVE_GETHOSTBYADDR_R
450 int buflen=BUFSTART, h_errno;
455 if (sa->sa_family == AF_INET6) {
456 struct sockaddr_in6 *sin = (struct sockaddr_in6 *)sa;
457 addr = (char *)&sin->sin6_addr;
458 alen = sizeof(sin->sin6_addr);
461 if (sa->sa_family == AF_INET) {
462 struct sockaddr_in *sin = (struct sockaddr_in *)sa;
463 addr = (char *)&sin->sin_addr;
464 alen = sizeof(sin->sin_addr);
467 *err = (char *)HSTRERROR( rc );
470 #if defined( HAVE_GETHOSTBYADDR_R )
471 for(;buflen<BUFMAX;) {
472 if (safe_realloc( &buf, buflen )==NULL) {
473 *err = (char *)STRERROR( ENOMEM );
476 #if (GETHOSTBYADDR_R_NARGS < 8)
477 hp=gethostbyaddr_r( addr, alen, sa->sa_family,
478 &hb, buf, buflen, &h_errno );
479 rc = (hp == NULL) ? -1 : 0;
481 rc = gethostbyaddr_r( addr, alen, sa->sa_family,
485 #ifdef NETDB_INTERNAL
487 (h_errno==NETDB_INTERNAL) &&
497 strncpy( name, hp->h_name, namelen );
499 *err = (char *)HSTRERROR( h_errno );
502 #else /* HAVE_GETHOSTBYADDR_R */
504 #if defined( LDAP_R_COMPILE )
505 ldap_pvt_thread_mutex_lock( &ldap_int_resolv_mutex );
507 hp = gethostbyaddr( addr, alen, sa->sa_family );
509 strncpy( name, hp->h_name, namelen );
513 *err = (char *)HSTRERROR( h_errno );
515 #if defined( LDAP_R_COMPILE )
516 ldap_pvt_thread_mutex_unlock( &ldap_int_resolv_mutex );
519 #endif /* !HAVE_GETHOSTBYADDR_R */
521 #endif /* !HAVE_GETNAMEINFO */
524 int ldap_pvt_gethostbyaddr_a(
528 struct hostent *resbuf,
530 struct hostent **result,
533 #if defined( HAVE_GETHOSTBYADDR_R )
535 # undef NEED_SAFE_REALLOC
536 # define NEED_SAFE_REALLOC
540 for(;buflen<BUFMAX;) {
541 if (safe_realloc( buf, buflen )==NULL)
543 #if (GETHOSTBYADDR_R_NARGS < 8)
544 *result=gethostbyaddr_r( addr, len, type,
545 resbuf, *buf, buflen, herrno_ptr );
546 r = (*result == NULL) ? -1 : 0;
548 r = gethostbyaddr_r( addr, len, type,
549 resbuf, *buf, buflen,
550 result, herrno_ptr );
553 #ifdef NETDB_INTERNAL
555 (*herrno_ptr==NETDB_INTERNAL) &&
565 #elif defined( LDAP_R_COMPILE )
566 # undef NEED_COPY_HOSTENT
567 # define NEED_COPY_HOSTENT
572 ldap_pvt_thread_mutex_lock( &ldap_int_resolv_mutex );
574 he = gethostbyaddr( addr, len, type );
577 *herrno_ptr = h_errno;
579 } else if (copy_hostent( resbuf, buf, he )<0) {
587 ldap_pvt_thread_mutex_unlock( &ldap_int_resolv_mutex );
591 #else /* gethostbyaddr() */
593 *result = gethostbyaddr( addr, len, type );
602 * ldap_int_utils_init() should be called before any other function.
605 void ldap_int_utils_init( void )
612 #ifdef LDAP_R_COMPILE
613 #if !defined( USE_CTIME_R ) && !defined( HAVE_REENTRANT_FUNCTIONS )
614 ldap_pvt_thread_mutex_init( &ldap_int_ctime_mutex );
616 #if !defined( USE_GMTIME_R ) && !defined( USE_LOCALTIME_R )
617 ldap_pvt_thread_mutex_init( &ldap_int_gmtime_mutex );
619 ldap_pvt_thread_mutex_init( &ldap_int_resolv_mutex );
621 #ifdef HAVE_CYRUS_SASL
622 ldap_pvt_thread_mutex_init( &ldap_int_sasl_mutex );
625 ldap_pvt_thread_mutex_init( &ldap_int_gssapi_mutex );
629 /* call other module init functions here... */
632 #if defined( NEED_COPY_HOSTENT )
633 # undef NEED_SAFE_REALLOC
634 #define NEED_SAFE_REALLOC
636 static char *cpy_aliases(
643 for( ; (*src) ; src++ ) {
644 len = strlen( *src ) + 1;
645 AC_MEMCPY( buf, *src, len );
653 static char *cpy_addresses(
660 for( ; (*src) ; src++ ) {
661 AC_MEMCPY( buf, *src, len );
669 static int copy_hostent(
672 struct hostent * src )
679 int total_alias_len=0;
681 int total_addr_len=0;
684 /* calculate the size needed for the buffer */
685 name_len = strlen( src->h_name ) + 1;
687 if( src->h_aliases != NULL ) {
688 for( p = src->h_aliases; (*p) != NULL; p++ ) {
689 total_alias_len += strlen( *p ) + 1;
694 if( src->h_addr_list != NULL ) {
695 for( p = src->h_addr_list; (*p) != NULL; p++ ) {
698 total_addr_len = n_addr * src->h_length;
701 total_len = (n_alias + n_addr + 2) * sizeof( char * ) +
702 total_addr_len + total_alias_len + name_len;
704 if (safe_realloc( buf, total_len )) {
706 tbuf = *buf + (n_alias + n_addr + 2) * sizeof( char * );
707 AC_MEMCPY( res, src, sizeof( struct hostent ) );
708 /* first the name... */
709 AC_MEMCPY( tbuf, src->h_name, name_len );
710 res->h_name = tbuf; tbuf+=name_len;
711 /* now the aliases */
713 if ( src->h_aliases != NULL ) {
714 tbuf = cpy_aliases( &tp, tbuf, src->h_aliases );
717 /* finally the addresses */
718 res->h_addr_list = tp;
719 if ( src->h_addr_list != NULL ) {
720 tbuf = cpy_addresses( &tp, tbuf, src->h_addr_list, src->h_length );
729 #if defined( NEED_SAFE_REALLOC )
730 static char *safe_realloc( char **buf, int len )
733 tmpbuf = LDAP_REALLOC( *buf, len );
741 char * ldap_pvt_get_fqdn( char *name )
744 char hostbuf[MAXHOSTNAMELEN+1];
745 struct hostent *hp, he_buf;
746 int rc, local_h_errno;
749 if( gethostname( hostbuf, MAXHOSTNAMELEN ) == 0 ) {
750 hostbuf[MAXHOSTNAMELEN] = '\0';
757 rc = ldap_pvt_gethostbyname_a( name,
758 &he_buf, &ha_buf, &hp, &local_h_errno );
760 if( rc < 0 || hp == NULL || hp->h_name == NULL ) {
761 fqdn = LDAP_STRDUP( name );
763 fqdn = LDAP_STRDUP( hp->h_name );
770 #if ( defined( HAVE_GETADDRINFO ) || defined( HAVE_GETNAMEINFO ) ) \
771 && !defined( HAVE_GAI_STRERROR )
772 char *ldap_pvt_gai_strerror (int code) {
777 #ifdef EAI_ADDRFAMILY
778 { EAI_ADDRFAMILY, N_("Address family for hostname not supported") },
780 { EAI_AGAIN, N_("Temporary failure in name resolution") },
781 { EAI_BADFLAGS, N_("Bad value for ai_flags") },
782 { EAI_FAIL, N_("Non-recoverable failure in name resolution") },
783 { EAI_FAMILY, N_("ai_family not supported") },
784 { EAI_MEMORY, N_("Memory allocation failure") },
786 { EAI_NODATA, N_("No address associated with hostname") },
788 { EAI_NONAME, N_("Name or service not known") },
789 { EAI_SERVICE, N_("Servname not supported for ai_socktype") },
790 { EAI_SOCKTYPE, N_("ai_socktype not supported") },
791 { EAI_SYSTEM, N_("System error") },
797 for ( i = 0; values[i].msg != NULL; i++ ) {
798 if ( values[i].code == code ) {
799 return (char *) _(values[i].msg);
803 return _("Unknown error");