Back to index

openldap  2.4.31
Classes | Defines | Functions | Variables
init.c File Reference
#include "portable.h"
#include <stdio.h>
#include <ac/stdlib.h>
#include <ac/socket.h>
#include <ac/string.h>
#include <ac/ctype.h>
#include <ac/time.h>
#include "ldap-int.h"
#include "ldap_defaults.h"
#include "lutil.h"

Go to the source code of this file.

Classes

struct  ol_keyvalue
struct  ol_attribute

Defines

#define ATTR_NONE   0
#define ATTR_BOOL   1
#define ATTR_INT   2
#define ATTR_KV   3
#define ATTR_STRING   4
#define ATTR_OPTION   5
#define ATTR_SASL   6
#define ATTR_TLS   7
#define ATTR_OPT_TV   8
#define ATTR_OPT_INT   9
#define ATTR_GSSAPI   10
#define MAX_LDAP_ATTR_LEN   sizeof("GSSAPI_ALLOW_REMOTE_PRINCIPAL")
#define MAX_LDAP_ENV_PREFIX_LEN   8

Functions

static void openldap_ldap_init_w_conf (const char *file, int userconf)
static void openldap_ldap_init_w_sysconf (const char *file)
static void openldap_ldap_init_w_userconf (const char *file)
static void openldap_ldap_init_w_env (struct ldapoptions *gopts, const char *prefix)
static void ldap_int_destroy_global_options (void)
void ldap_int_initialize_global_options (struct ldapoptions *gopts, int *dbglvl)
void ldap_int_initialize (struct ldapoptions *gopts, int *dbglvl)

Variables

static struct ol_keyvalue []
static struct ol_attribute attrs []

Class Documentation

struct ol_keyvalue

Definition at line 56 of file init.c.

Class Members
const char * key
int value
struct ol_attribute

Definition at line 69 of file init.c.

Class Members
const void * data
const char * name
size_t offset
int type
int useronly

Define Documentation

#define ATTR_BOOL   1

Definition at line 42 of file init.c.

#define ATTR_GSSAPI   10

Definition at line 54 of file init.c.

#define ATTR_INT   2

Definition at line 43 of file init.c.

#define ATTR_KV   3

Definition at line 44 of file init.c.

#define ATTR_NONE   0

Definition at line 41 of file init.c.

#define ATTR_OPT_INT   9

Definition at line 52 of file init.c.

#define ATTR_OPT_TV   8

Definition at line 51 of file init.c.

#define ATTR_OPTION   5

Definition at line 46 of file init.c.

#define ATTR_SASL   6

Definition at line 48 of file init.c.

#define ATTR_STRING   4

Definition at line 45 of file init.c.

#define ATTR_TLS   7

Definition at line 49 of file init.c.

#define MAX_LDAP_ATTR_LEN   sizeof("GSSAPI_ALLOW_REMOTE_PRINCIPAL")

Definition at line 140 of file init.c.

#define MAX_LDAP_ENV_PREFIX_LEN   8

Definition at line 141 of file init.c.


Function Documentation

static void ldap_int_destroy_global_options ( void  ) [static]

Definition at line 474 of file init.c.

{
       struct ldapoptions *gopts = LDAP_INT_GLOBAL_OPT();

       if ( gopts == NULL )
              return;

       gopts->ldo_valid = LDAP_UNINITIALIZED;

       if ( gopts->ldo_defludp ) {
              ldap_free_urllist( gopts->ldo_defludp );
              gopts->ldo_defludp = NULL;
       }
#if defined(HAVE_WINSOCK) || defined(HAVE_WINSOCK2)
       WSACleanup( );
#endif

#if defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
       if ( ldap_int_hostname ) {
              LDAP_FREE( ldap_int_hostname );
              ldap_int_hostname = NULL;
       }
#endif
#ifdef HAVE_CYRUS_SASL
       if ( gopts->ldo_def_sasl_authcid ) {
              LDAP_FREE( gopts->ldo_def_sasl_authcid );
              gopts->ldo_def_sasl_authcid = NULL;
       }
#endif
#ifdef HAVE_TLS
       ldap_int_tls_destroy( gopts );
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

void ldap_int_initialize ( struct ldapoptions gopts,
int dbglvl 
)

Definition at line 593 of file init.c.

{
       if ( gopts->ldo_valid == LDAP_INITIALIZED ) {
              return;
       }

       ldap_int_error_init();

       ldap_int_utils_init();

#ifdef HAVE_WINSOCK2
{      WORD wVersionRequested;
       WSADATA wsaData;
 
       wVersionRequested = MAKEWORD( 2, 0 );
       if ( WSAStartup( wVersionRequested, &wsaData ) != 0 ) {
              /* Tell the user that we couldn't find a usable */
              /* WinSock DLL.                                  */
              return;
       }
 
       /* Confirm that the WinSock DLL supports 2.0.*/
       /* Note that if the DLL supports versions greater    */
       /* than 2.0 in addition to 2.0, it will still return */
       /* 2.0 in wVersion since that is the version we      */
       /* requested.                                        */
 
       if ( LOBYTE( wsaData.wVersion ) != 2 ||
              HIBYTE( wsaData.wVersion ) != 0 )
       {
           /* Tell the user that we couldn't find a usable */
           /* WinSock DLL.                                  */
           WSACleanup( );
           return; 
       }
}      /* The WinSock DLL is acceptable. Proceed. */
#elif defined(HAVE_WINSOCK)
{      WSADATA wsaData;
       if ( WSAStartup( 0x0101, &wsaData ) != 0 ) {
           return;
       }
}
#endif

#if defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
       {
              char   *name = ldap_int_hostname;

              ldap_int_hostname = ldap_pvt_get_fqdn( name );

              if ( name != NULL && name != ldap_int_hostname ) {
                     LDAP_FREE( name );
              }
       }
#endif

#ifndef HAVE_POLL
       if ( ldap_int_tblsize == 0 ) ldap_int_ip_init();
#endif

       ldap_int_initialize_global_options(gopts, NULL);

       if( getenv("LDAPNOINIT") != NULL ) {
              return;
       }

#ifdef HAVE_CYRUS_SASL
       {
              /* set authentication identity to current user name */
              char *user = getenv("USER");

              if( user == NULL ) user = getenv("USERNAME");
              if( user == NULL ) user = getenv("LOGNAME");

              if( user != NULL ) {
                     gopts->ldo_def_sasl_authcid = LDAP_STRDUP( user );
              }
    }
#endif

       openldap_ldap_init_w_sysconf(LDAP_CONF_FILE);

#ifdef HAVE_GETEUID
       if ( geteuid() != getuid() )
              return;
#endif

       openldap_ldap_init_w_userconf(LDAP_USERRC_FILE);

       {
              char *altfile = getenv(LDAP_ENV_PREFIX "CONF");

              if( altfile != NULL ) {
                     Debug(LDAP_DEBUG_TRACE, "ldap_init: %s env is %s\n",
                           LDAP_ENV_PREFIX "CONF", altfile, 0);
                     openldap_ldap_init_w_sysconf( altfile );
              }
              else
                     Debug(LDAP_DEBUG_TRACE, "ldap_init: %s env is NULL\n",
                           LDAP_ENV_PREFIX "CONF", 0, 0);
       }

       {
              char *altfile = getenv(LDAP_ENV_PREFIX "RC");

              if( altfile != NULL ) {
                     Debug(LDAP_DEBUG_TRACE, "ldap_init: %s env is %s\n",
                           LDAP_ENV_PREFIX "RC", altfile, 0);
                     openldap_ldap_init_w_userconf( altfile );
              }
              else
                     Debug(LDAP_DEBUG_TRACE, "ldap_init: %s env is NULL\n",
                           LDAP_ENV_PREFIX "RC", 0, 0);
       }

       openldap_ldap_init_w_env(gopts, NULL);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void ldap_int_initialize_global_options ( struct ldapoptions gopts,
int dbglvl 
)

Definition at line 511 of file init.c.

{
#ifdef LDAP_R_COMPILE
       LDAP_PVT_MUTEX_FIRSTCREATE(gopts->ldo_mutex);
#endif
       LDAP_MUTEX_LOCK( &gopts->ldo_mutex );
       if (gopts->ldo_valid == LDAP_INITIALIZED) {
              /* someone else got here first */
              LDAP_MUTEX_UNLOCK( &gopts->ldo_mutex );
              return;
       }
       if (dbglvl)
           gopts->ldo_debug = *dbglvl;
       else
              gopts->ldo_debug = 0;

       gopts->ldo_version   = LDAP_VERSION2;
       gopts->ldo_deref     = LDAP_DEREF_NEVER;
       gopts->ldo_timelimit = LDAP_NO_LIMIT;
       gopts->ldo_sizelimit = LDAP_NO_LIMIT;

       gopts->ldo_tm_api.tv_sec = -1;
       gopts->ldo_tm_net.tv_sec = -1;

       /* ldo_defludp will be freed by the termination handler
        */
       ldap_url_parselist(&gopts->ldo_defludp, "ldap://localhost/");
       gopts->ldo_defport = LDAP_PORT;
#if !defined(__GNUC__) && !defined(PIC)
       /* Do this only for a static library, and only if we can't
        * arrange for it to be executed as a library destructor
        */
       atexit(ldap_int_destroy_global_options);
#endif

       gopts->ldo_refhoplimit = LDAP_DEFAULT_REFHOPLIMIT;
       gopts->ldo_rebind_proc = NULL;
       gopts->ldo_rebind_params = NULL;

       LDAP_BOOL_ZERO(gopts);

       LDAP_BOOL_SET(gopts, LDAP_BOOL_REFERRALS);

#ifdef LDAP_CONNECTIONLESS
       gopts->ldo_peer = NULL;
       gopts->ldo_cldapdn = NULL;
       gopts->ldo_is_udp = 0;
#endif

#ifdef HAVE_CYRUS_SASL
       gopts->ldo_def_sasl_mech = NULL;
       gopts->ldo_def_sasl_realm = NULL;
       gopts->ldo_def_sasl_authcid = NULL;
       gopts->ldo_def_sasl_authzid = NULL;

       memset( &gopts->ldo_sasl_secprops,
              '\0', sizeof(gopts->ldo_sasl_secprops) );

       gopts->ldo_sasl_secprops.max_ssf = INT_MAX;
       gopts->ldo_sasl_secprops.maxbufsize = SASL_MAX_BUFF_SIZE;
       gopts->ldo_sasl_secprops.security_flags =
              SASL_SEC_NOPLAINTEXT | SASL_SEC_NOANONYMOUS;
#endif

#ifdef HAVE_TLS
       gopts->ldo_tls_connect_cb = NULL;
       gopts->ldo_tls_connect_arg = NULL;
       gopts->ldo_tls_require_cert = LDAP_OPT_X_TLS_DEMAND;
#endif
       gopts->ldo_keepalive_probes = 0;
       gopts->ldo_keepalive_interval = 0;
       gopts->ldo_keepalive_idle = 0;

       gopts->ldo_valid = LDAP_INITIALIZED;
       LDAP_MUTEX_UNLOCK( &gopts->ldo_mutex );
       return;
}

Here is the call graph for this function:

Here is the caller graph for this function:

static void openldap_ldap_init_w_conf ( const char *  file,
int  userconf 
) [static]

Definition at line 143 of file init.c.

{
       char linebuf[ AC_LINE_MAX ];
       FILE *fp;
       int i;
       char *cmd, *opt;
       char *start, *end;
       struct ldapoptions *gopts;

       if ((gopts = LDAP_INT_GLOBAL_OPT()) == NULL) {
              return;                     /* Could not allocate mem for global options */
       }

       if (file == NULL) {
              /* no file name */
              return;
       }

       Debug(LDAP_DEBUG_TRACE, "ldap_init: trying %s\n", file, 0, 0);

       fp = fopen(file, "r");
       if(fp == NULL) {
              /* could not open file */
              return;
       }

       Debug(LDAP_DEBUG_TRACE, "ldap_init: using %s\n", file, 0, 0);

       while((start = fgets(linebuf, sizeof(linebuf), fp)) != NULL) {
              /* skip lines starting with '#' */
              if(*start == '#') continue;

              /* trim leading white space */
              while((*start != '\0') && isspace((unsigned char) *start))
                     start++;

              /* anything left? */
              if(*start == '\0') continue;

              /* trim trailing white space */
              end = &start[strlen(start)-1];
              while(isspace((unsigned char)*end)) end--;
              end[1] = '\0';

              /* anything left? */
              if(*start == '\0') continue;
              

              /* parse the command */
              cmd=start;
              while((*start != '\0') && !isspace((unsigned char)*start)) {
                     start++;
              }
              if(*start == '\0') {
                     /* command has no argument */
                     continue;
              } 

              *start++ = '\0';

              /* we must have some whitespace to skip */
              while(isspace((unsigned char)*start)) start++;
              opt = start;

              for(i=0; attrs[i].type != ATTR_NONE; i++) {
                     void *p;

                     if( !userconf && attrs[i].useronly ) {
                            continue;
                     }

                     if(strcasecmp(cmd, attrs[i].name) != 0) {
                            continue;
                     }

                     switch(attrs[i].type) {
                     case ATTR_BOOL:
                            if((strcasecmp(opt, "on") == 0) 
                                   || (strcasecmp(opt, "yes") == 0)
                                   || (strcasecmp(opt, "true") == 0))
                            {
                                   LDAP_BOOL_SET(gopts, attrs[i].offset);

                            } else {
                                   LDAP_BOOL_CLR(gopts, attrs[i].offset);
                            }

                            break;

                     case ATTR_INT: {
                            char *next;
                            long l;
                            p = &((char *) gopts)[attrs[i].offset];
                            l = strtol( opt, &next, 10 );
                            if ( next != opt && next[ 0 ] == '\0' ) {
                                   * (int*) p = l;
                            }
                            } break;

                     case ATTR_KV: {
                                   const struct ol_keyvalue *kv;

                                   for(kv = attrs[i].data;
                                          kv->key != NULL;
                                          kv++) {

                                          if(strcasecmp(opt, kv->key) == 0) {
                                                 p = &((char *) gopts)[attrs[i].offset];
                                                 * (int*) p = kv->value;
                                                 break;
                                          }
                                   }
                            } break;

                     case ATTR_STRING:
                            p = &((char *) gopts)[attrs[i].offset];
                            if (* (char**) p != NULL) LDAP_FREE(* (char**) p);
                            * (char**) p = LDAP_STRDUP(opt);
                            break;
                     case ATTR_OPTION:
                            ldap_set_option( NULL, attrs[i].offset, opt );
                            break;
                     case ATTR_SASL:
#ifdef HAVE_CYRUS_SASL
                            ldap_int_sasl_config( gopts, attrs[i].offset, opt );
#endif
                            break;
                     case ATTR_GSSAPI:
#ifdef HAVE_GSSAPI
                            ldap_int_gssapi_config( gopts, attrs[i].offset, opt );
#endif
                            break;
                     case ATTR_TLS:
#ifdef HAVE_TLS
                            ldap_int_tls_config( NULL, attrs[i].offset, opt );
#endif
                            break;
                     case ATTR_OPT_TV: {
                            struct timeval tv;
                            char *next;
                            tv.tv_usec = 0;
                            tv.tv_sec = strtol( opt, &next, 10 );
                            if ( next != opt && next[ 0 ] == '\0' && tv.tv_sec > 0 ) {
                                   (void)ldap_set_option( NULL, attrs[i].offset, (const void *)&tv );
                            }
                            } break;
                     case ATTR_OPT_INT: {
                            long l;
                            char *next;
                            l = strtol( opt, &next, 10 );
                            if ( next != opt && next[ 0 ] == '\0' && l > 0 && (long)((int)l) == l ) {
                                   int v = (int)l;
                                   (void)ldap_set_option( NULL, attrs[i].offset, (const void *)&v );
                            }
                            } break;
                     }

                     break;
              }
       }

       fclose(fp);
}

Here is the call graph for this function:

Here is the caller graph for this function:

static void openldap_ldap_init_w_env ( struct ldapoptions gopts,
const char *  prefix 
) [static]

Definition at line 354 of file init.c.

{
       char buf[MAX_LDAP_ATTR_LEN+MAX_LDAP_ENV_PREFIX_LEN];
       int len;
       int i;
       void *p;
       char *value;

       if (prefix == NULL) {
              prefix = LDAP_ENV_PREFIX;
       }

       strncpy(buf, prefix, MAX_LDAP_ENV_PREFIX_LEN);
       buf[MAX_LDAP_ENV_PREFIX_LEN] = '\0';
       len = strlen(buf);

       for(i=0; attrs[i].type != ATTR_NONE; i++) {
              strcpy(&buf[len], attrs[i].name);
              value = getenv(buf);

              if(value == NULL) {
                     continue;
              }

              switch(attrs[i].type) {
              case ATTR_BOOL:
                     if((strcasecmp(value, "on") == 0) 
                            || (strcasecmp(value, "yes") == 0)
                            || (strcasecmp(value, "true") == 0))
                     {
                            LDAP_BOOL_SET(gopts, attrs[i].offset);

                     } else {
                            LDAP_BOOL_CLR(gopts, attrs[i].offset);
                     }
                     break;

              case ATTR_INT:
                     p = &((char *) gopts)[attrs[i].offset];
                     * (int*) p = atoi(value);
                     break;

              case ATTR_KV: {
                            const struct ol_keyvalue *kv;

                            for(kv = attrs[i].data;
                                   kv->key != NULL;
                                   kv++) {

                                   if(strcasecmp(value, kv->key) == 0) {
                                          p = &((char *) gopts)[attrs[i].offset];
                                          * (int*) p = kv->value;
                                          break;
                                   }
                            }
                     } break;

              case ATTR_STRING:
                     p = &((char *) gopts)[attrs[i].offset];
                     if (* (char**) p != NULL) LDAP_FREE(* (char**) p);
                     if (*value == '\0') {
                            * (char**) p = NULL;
                     } else {
                            * (char**) p = LDAP_STRDUP(value);
                     }
                     break;
              case ATTR_OPTION:
                     ldap_set_option( NULL, attrs[i].offset, value );
                     break;
              case ATTR_SASL:
#ifdef HAVE_CYRUS_SASL
                     ldap_int_sasl_config( gopts, attrs[i].offset, value );
#endif                      
                     break;
              case ATTR_GSSAPI:
#ifdef HAVE_GSSAPI
                     ldap_int_gssapi_config( gopts, attrs[i].offset, value );
#endif
                     break;
              case ATTR_TLS:
#ifdef HAVE_TLS
                     ldap_int_tls_config( NULL, attrs[i].offset, value );
#endif                      
                     break;
              case ATTR_OPT_TV: {
                     struct timeval tv;
                     char *next;
                     tv.tv_usec = 0;
                     tv.tv_sec = strtol( value, &next, 10 );
                     if ( next != value && next[ 0 ] == '\0' && tv.tv_sec > 0 ) {
                            (void)ldap_set_option( NULL, attrs[i].offset, (const void *)&tv );
                     }
                     } break;
              case ATTR_OPT_INT: {
                     long l;
                     char *next;
                     l = strtol( value, &next, 10 );
                     if ( next != value && next[ 0 ] == '\0' && l > 0 && (long)((int)l) == l ) {
                            int v = (int)l;
                            (void)ldap_set_option( NULL, attrs[i].offset, (const void *)&v );
                     }
                     } break;
              }
       }
}

Here is the call graph for this function:

Here is the caller graph for this function:

static void openldap_ldap_init_w_sysconf ( const char *  file) [static]

Definition at line 308 of file init.c.

{
       openldap_ldap_init_w_conf( file, 0 );
}

Here is the call graph for this function:

Here is the caller graph for this function:

static void openldap_ldap_init_w_userconf ( const char *  file) [static]

Definition at line 313 of file init.c.

{
       char *home;
       char *path = NULL;

       if (file == NULL) {
              /* no file name */
              return;
       }

       home = getenv("HOME");

       if (home != NULL) {
              Debug(LDAP_DEBUG_TRACE, "ldap_init: HOME env is %s\n",
                    home, 0, 0);
              path = LDAP_MALLOC(strlen(home) + strlen(file) + sizeof( LDAP_DIRSEP "."));
       } else {
              Debug(LDAP_DEBUG_TRACE, "ldap_init: HOME env is NULL\n",
                    0, 0, 0);
       }

       if(home != NULL && path != NULL) {
              /* we assume UNIX path syntax is used... */

              /* try ~/file */
              sprintf(path, "%s" LDAP_DIRSEP "%s", home, file);
              openldap_ldap_init_w_conf(path, 1);

              /* try ~/.file */
              sprintf(path, "%s" LDAP_DIRSEP ".%s", home, file);
              openldap_ldap_init_w_conf(path, 1);
       }

       if(path != NULL) {
              LDAP_FREE(path);
       }

       /* try file */
       openldap_ldap_init_w_conf(file, 1);
}

Here is the call graph for this function:

Here is the caller graph for this function:


Variable Documentation

struct ol_attribute attrs[] [static]
struct ol_keyvalue[] [static]
Initial value:
 {
       {"never", LDAP_DEREF_NEVER},
       {"searching", LDAP_DEREF_SEARCHING},
       {"finding", LDAP_DEREF_FINDING},
       {"always", LDAP_DEREF_ALWAYS},
       {NULL, 0}
}

Definition at line 61 of file init.c.