2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2011 The OpenLDAP Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
11 * A copy of this license is available in the file LICENSE in the
12 * top-level directory of the distribution or, alternatively, at
13 * <http://www.OpenLDAP.org/license.html>.
19 #include <ac/stdlib.h>
22 #include <ac/unistd.h>
25 #include <ac/socket.h>
26 #include <ac/string.h>
35 #include "ldap_defaults.h"
38 struct ldapoptions ldap_int_global_options =
39 { LDAP_UNINITIALIZED, LDAP_DEBUG_NONE LDAP_LDO_MUTEX_NULLARG };
52 #define ATTR_OPT_INT 9
54 #define ATTR_GSSAPI 10
61 static const struct ol_keyvalue deref_kv[] = {
62 {"never", LDAP_DEREF_NEVER},
63 {"searching", LDAP_DEREF_SEARCHING},
64 {"finding", LDAP_DEREF_FINDING},
65 {"always", LDAP_DEREF_ALWAYS},
69 static const struct ol_attribute {
76 {0, ATTR_OPT_TV, "TIMEOUT", NULL, LDAP_OPT_TIMEOUT},
77 {0, ATTR_OPT_TV, "NETWORK_TIMEOUT", NULL, LDAP_OPT_NETWORK_TIMEOUT},
78 {0, ATTR_OPT_INT, "VERSION", NULL, LDAP_OPT_PROTOCOL_VERSION},
79 {0, ATTR_KV, "DEREF", deref_kv, /* or &deref_kv[0] */
80 offsetof(struct ldapoptions, ldo_deref)},
81 {0, ATTR_INT, "SIZELIMIT", NULL,
82 offsetof(struct ldapoptions, ldo_sizelimit)},
83 {0, ATTR_INT, "TIMELIMIT", NULL,
84 offsetof(struct ldapoptions, ldo_timelimit)},
85 {1, ATTR_STRING, "BINDDN", NULL,
86 offsetof(struct ldapoptions, ldo_defbinddn)},
87 {0, ATTR_STRING, "BASE", NULL,
88 offsetof(struct ldapoptions, ldo_defbase)},
89 {0, ATTR_INT, "PORT", NULL, /* deprecated */
90 offsetof(struct ldapoptions, ldo_defport)},
91 {0, ATTR_OPTION, "HOST", NULL, LDAP_OPT_HOST_NAME}, /* deprecated */
92 {0, ATTR_OPTION, "URI", NULL, LDAP_OPT_URI}, /* replaces HOST/PORT */
93 {0, ATTR_BOOL, "REFERRALS", NULL, LDAP_BOOL_REFERRALS},
95 /* This should only be allowed via ldap_set_option(3) */
96 {0, ATTR_BOOL, "RESTART", NULL, LDAP_BOOL_RESTART},
99 #ifdef HAVE_CYRUS_SASL
100 {0, ATTR_STRING, "SASL_MECH", NULL,
101 offsetof(struct ldapoptions, ldo_def_sasl_mech)},
102 {0, ATTR_STRING, "SASL_REALM", NULL,
103 offsetof(struct ldapoptions, ldo_def_sasl_realm)},
104 {1, ATTR_STRING, "SASL_AUTHCID", NULL,
105 offsetof(struct ldapoptions, ldo_def_sasl_authcid)},
106 {1, ATTR_STRING, "SASL_AUTHZID", NULL,
107 offsetof(struct ldapoptions, ldo_def_sasl_authzid)},
108 {0, ATTR_SASL, "SASL_SECPROPS", NULL, LDAP_OPT_X_SASL_SECPROPS},
109 {0, ATTR_BOOL, "SASL_NOCANON", NULL, LDAP_BOOL_SASL_NOCANON},
113 {0, ATTR_GSSAPI,"GSSAPI_SIGN", NULL, LDAP_OPT_SIGN},
114 {0, ATTR_GSSAPI,"GSSAPI_ENCRYPT", NULL, LDAP_OPT_ENCRYPT},
115 {0, ATTR_GSSAPI,"GSSAPI_ALLOW_REMOTE_PRINCIPAL",NULL, LDAP_OPT_X_GSSAPI_ALLOW_REMOTE_PRINCIPAL},
119 {1, ATTR_TLS, "TLS_CERT", NULL, LDAP_OPT_X_TLS_CERTFILE},
120 {1, ATTR_TLS, "TLS_KEY", NULL, LDAP_OPT_X_TLS_KEYFILE},
121 {0, ATTR_TLS, "TLS_CACERT", NULL, LDAP_OPT_X_TLS_CACERTFILE},
122 {0, ATTR_TLS, "TLS_CACERTDIR", NULL, LDAP_OPT_X_TLS_CACERTDIR},
123 {0, ATTR_TLS, "TLS_REQCERT", NULL, LDAP_OPT_X_TLS_REQUIRE_CERT},
124 {0, ATTR_TLS, "TLS_RANDFILE", NULL, LDAP_OPT_X_TLS_RANDOM_FILE},
125 {0, ATTR_TLS, "TLS_CIPHER_SUITE", NULL, LDAP_OPT_X_TLS_CIPHER_SUITE},
126 {0, ATTR_TLS, "TLS_PROTOCOL_MIN", NULL, LDAP_OPT_X_TLS_PROTOCOL_MIN},
128 #ifdef HAVE_OPENSSL_CRL
129 {0, ATTR_TLS, "TLS_CRLCHECK", NULL, LDAP_OPT_X_TLS_CRLCHECK},
132 {0, ATTR_TLS, "TLS_CRLFILE", NULL, LDAP_OPT_X_TLS_CRLFILE},
137 {0, ATTR_NONE, NULL, NULL, 0}
140 #define MAX_LDAP_ATTR_LEN sizeof("GSSAPI_ALLOW_REMOTE_PRINCIPAL")
141 #define MAX_LDAP_ENV_PREFIX_LEN 8
143 static void openldap_ldap_init_w_conf(
144 const char *file, int userconf )
146 char linebuf[ AC_LINE_MAX ];
151 struct ldapoptions *gopts;
153 if ((gopts = LDAP_INT_GLOBAL_OPT()) == NULL) {
154 return; /* Could not allocate mem for global options */
162 Debug(LDAP_DEBUG_TRACE, "ldap_init: trying %s\n", file, 0, 0);
164 fp = fopen(file, "r");
166 /* could not open file */
170 Debug(LDAP_DEBUG_TRACE, "ldap_init: using %s\n", file, 0, 0);
172 while((start = fgets(linebuf, sizeof(linebuf), fp)) != NULL) {
173 /* skip lines starting with '#' */
174 if(*start == '#') continue;
176 /* trim leading white space */
177 while((*start != '\0') && isspace((unsigned char) *start))
181 if(*start == '\0') continue;
183 /* trim trailing white space */
184 end = &start[strlen(start)-1];
185 while(isspace((unsigned char)*end)) end--;
189 if(*start == '\0') continue;
192 /* parse the command */
194 while((*start != '\0') && !isspace((unsigned char)*start)) {
198 /* command has no argument */
204 /* we must have some whitespace to skip */
205 while(isspace((unsigned char)*start)) start++;
208 for(i=0; attrs[i].type != ATTR_NONE; i++) {
211 if( !userconf && attrs[i].useronly ) {
215 if(strcasecmp(cmd, attrs[i].name) != 0) {
219 switch(attrs[i].type) {
221 if((strcasecmp(opt, "on") == 0)
222 || (strcasecmp(opt, "yes") == 0)
223 || (strcasecmp(opt, "true") == 0))
225 LDAP_BOOL_SET(gopts, attrs[i].offset);
228 LDAP_BOOL_CLR(gopts, attrs[i].offset);
236 p = &((char *) gopts)[attrs[i].offset];
237 l = strtol( opt, &next, 10 );
238 if ( next != opt && next[ 0 ] == '\0' ) {
244 const struct ol_keyvalue *kv;
246 for(kv = attrs[i].data;
250 if(strcasecmp(opt, kv->key) == 0) {
251 p = &((char *) gopts)[attrs[i].offset];
252 * (int*) p = kv->value;
259 p = &((char *) gopts)[attrs[i].offset];
260 if (* (char**) p != NULL) LDAP_FREE(* (char**) p);
261 * (char**) p = LDAP_STRDUP(opt);
264 ldap_set_option( NULL, attrs[i].offset, opt );
267 #ifdef HAVE_CYRUS_SASL
268 ldap_int_sasl_config( gopts, attrs[i].offset, opt );
273 ldap_int_gssapi_config( gopts, attrs[i].offset, opt );
278 ldap_pvt_tls_config( NULL, attrs[i].offset, opt );
285 tv.tv_sec = strtol( opt, &next, 10 );
286 if ( next != opt && next[ 0 ] == '\0' && tv.tv_sec > 0 ) {
287 (void)ldap_set_option( NULL, attrs[i].offset, (const void *)&tv );
293 l = strtol( opt, &next, 10 );
294 if ( next != opt && next[ 0 ] == '\0' && l > 0 && (long)((int)l) == l ) {
296 (void)ldap_set_option( NULL, attrs[i].offset, (const void *)&v );
308 static void openldap_ldap_init_w_sysconf(const char *file)
310 openldap_ldap_init_w_conf( file, 0 );
313 static void openldap_ldap_init_w_userconf(const char *file)
323 home = getenv("HOME");
326 Debug(LDAP_DEBUG_TRACE, "ldap_init: HOME env is %s\n",
328 path = LDAP_MALLOC(strlen(home) + strlen(file) + sizeof( LDAP_DIRSEP "."));
330 Debug(LDAP_DEBUG_TRACE, "ldap_init: HOME env is NULL\n",
334 if(home != NULL && path != NULL) {
335 /* we assume UNIX path syntax is used... */
338 sprintf(path, "%s" LDAP_DIRSEP "%s", home, file);
339 openldap_ldap_init_w_conf(path, 1);
342 sprintf(path, "%s" LDAP_DIRSEP ".%s", home, file);
343 openldap_ldap_init_w_conf(path, 1);
351 openldap_ldap_init_w_conf(file, 1);
354 static void openldap_ldap_init_w_env(
355 struct ldapoptions *gopts,
358 char buf[MAX_LDAP_ATTR_LEN+MAX_LDAP_ENV_PREFIX_LEN];
364 if (prefix == NULL) {
365 prefix = LDAP_ENV_PREFIX;
368 strncpy(buf, prefix, MAX_LDAP_ENV_PREFIX_LEN);
369 buf[MAX_LDAP_ENV_PREFIX_LEN] = '\0';
372 for(i=0; attrs[i].type != ATTR_NONE; i++) {
373 strcpy(&buf[len], attrs[i].name);
380 switch(attrs[i].type) {
382 if((strcasecmp(value, "on") == 0)
383 || (strcasecmp(value, "yes") == 0)
384 || (strcasecmp(value, "true") == 0))
386 LDAP_BOOL_SET(gopts, attrs[i].offset);
389 LDAP_BOOL_CLR(gopts, attrs[i].offset);
394 p = &((char *) gopts)[attrs[i].offset];
395 * (int*) p = atoi(value);
399 const struct ol_keyvalue *kv;
401 for(kv = attrs[i].data;
405 if(strcasecmp(value, kv->key) == 0) {
406 p = &((char *) gopts)[attrs[i].offset];
407 * (int*) p = kv->value;
414 p = &((char *) gopts)[attrs[i].offset];
415 if (* (char**) p != NULL) LDAP_FREE(* (char**) p);
416 if (*value == '\0') {
419 * (char**) p = LDAP_STRDUP(value);
423 ldap_set_option( NULL, attrs[i].offset, value );
426 #ifdef HAVE_CYRUS_SASL
427 ldap_int_sasl_config( gopts, attrs[i].offset, value );
432 ldap_int_gssapi_config( gopts, attrs[i].offset, value );
437 ldap_pvt_tls_config( NULL, attrs[i].offset, value );
444 tv.tv_sec = strtol( value, &next, 10 );
445 if ( next != value && next[ 0 ] == '\0' && tv.tv_sec > 0 ) {
446 (void)ldap_set_option( NULL, attrs[i].offset, (const void *)&tv );
452 l = strtol( value, &next, 10 );
453 if ( next != value && next[ 0 ] == '\0' && l > 0 && (long)((int)l) == l ) {
455 (void)ldap_set_option( NULL, attrs[i].offset, (const void *)&v );
462 #if defined(__GNUC__)
463 /* Declare this function as a destructor so that it will automatically be
464 * invoked either at program exit (if libldap is a static library) or
465 * at unload time (if libldap is a dynamic library).
467 * Sorry, don't know how to handle this for non-GCC environments.
469 static void ldap_int_destroy_global_options(void)
470 __attribute__ ((destructor));
474 ldap_int_destroy_global_options(void)
476 struct ldapoptions *gopts = LDAP_INT_GLOBAL_OPT();
481 gopts->ldo_valid = LDAP_UNINITIALIZED;
483 if ( gopts->ldo_defludp ) {
484 ldap_free_urllist( gopts->ldo_defludp );
485 gopts->ldo_defludp = NULL;
487 #if defined(HAVE_WINSOCK) || defined(HAVE_WINSOCK2)
491 #if defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
492 if ( ldap_int_hostname ) {
493 LDAP_FREE( ldap_int_hostname );
494 ldap_int_hostname = NULL;
497 #ifdef HAVE_CYRUS_SASL
498 if ( gopts->ldo_def_sasl_authcid ) {
499 LDAP_FREE( gopts->ldo_def_sasl_authcid );
500 gopts->ldo_def_sasl_authcid = NULL;
504 ldap_int_tls_destroy( gopts );
509 * Initialize the global options structure with default values.
511 void ldap_int_initialize_global_options( struct ldapoptions *gopts, int *dbglvl )
513 #ifdef LDAP_R_COMPILE
514 LDAP_PVT_MUTEX_FIRSTCREATE(gopts->ldo_mutex);
516 LDAP_MUTEX_LOCK( &gopts->ldo_mutex );
517 if (gopts->ldo_valid == LDAP_INITIALIZED) {
518 /* someone else got here first */
519 LDAP_MUTEX_UNLOCK( &gopts->ldo_mutex );
523 gopts->ldo_debug = *dbglvl;
525 gopts->ldo_debug = 0;
527 gopts->ldo_version = LDAP_VERSION2;
528 gopts->ldo_deref = LDAP_DEREF_NEVER;
529 gopts->ldo_timelimit = LDAP_NO_LIMIT;
530 gopts->ldo_sizelimit = LDAP_NO_LIMIT;
532 gopts->ldo_tm_api.tv_sec = -1;
533 gopts->ldo_tm_net.tv_sec = -1;
535 /* ldo_defludp will be freed by the termination handler
537 ldap_url_parselist(&gopts->ldo_defludp, "ldap://localhost/");
538 gopts->ldo_defport = LDAP_PORT;
539 #if !defined(__GNUC__) && !defined(PIC)
540 /* Do this only for a static library, and only if we can't
541 * arrange for it to be executed as a library destructor
543 atexit(ldap_int_destroy_global_options);
546 gopts->ldo_refhoplimit = LDAP_DEFAULT_REFHOPLIMIT;
547 gopts->ldo_rebind_proc = NULL;
548 gopts->ldo_rebind_params = NULL;
550 LDAP_BOOL_ZERO(gopts);
552 LDAP_BOOL_SET(gopts, LDAP_BOOL_REFERRALS);
554 #ifdef LDAP_CONNECTIONLESS
555 gopts->ldo_peer = NULL;
556 gopts->ldo_cldapdn = NULL;
557 gopts->ldo_is_udp = 0;
560 #ifdef HAVE_CYRUS_SASL
561 gopts->ldo_def_sasl_mech = NULL;
562 gopts->ldo_def_sasl_realm = NULL;
563 gopts->ldo_def_sasl_authcid = NULL;
564 gopts->ldo_def_sasl_authzid = NULL;
566 memset( &gopts->ldo_sasl_secprops,
567 '\0', sizeof(gopts->ldo_sasl_secprops) );
569 gopts->ldo_sasl_secprops.max_ssf = INT_MAX;
570 gopts->ldo_sasl_secprops.maxbufsize = SASL_MAX_BUFF_SIZE;
571 gopts->ldo_sasl_secprops.security_flags =
572 SASL_SEC_NOPLAINTEXT | SASL_SEC_NOANONYMOUS;
576 gopts->ldo_tls_connect_cb = NULL;
577 gopts->ldo_tls_connect_arg = NULL;
578 gopts->ldo_tls_require_cert = LDAP_OPT_X_TLS_DEMAND;
580 gopts->ldo_keepalive_probes = 0;
581 gopts->ldo_keepalive_interval = 0;
582 gopts->ldo_keepalive_idle = 0;
584 gopts->ldo_valid = LDAP_INITIALIZED;
585 LDAP_MUTEX_UNLOCK( &gopts->ldo_mutex );
589 #if defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
590 char * ldap_int_hostname = NULL;
593 void ldap_int_initialize( struct ldapoptions *gopts, int *dbglvl )
595 if ( gopts->ldo_valid == LDAP_INITIALIZED ) {
599 ldap_int_error_init();
601 ldap_int_utils_init();
604 { WORD wVersionRequested;
607 wVersionRequested = MAKEWORD( 2, 0 );
608 if ( WSAStartup( wVersionRequested, &wsaData ) != 0 ) {
609 /* Tell the user that we couldn't find a usable */
614 /* Confirm that the WinSock DLL supports 2.0.*/
615 /* Note that if the DLL supports versions greater */
616 /* than 2.0 in addition to 2.0, it will still return */
617 /* 2.0 in wVersion since that is the version we */
620 if ( LOBYTE( wsaData.wVersion ) != 2 ||
621 HIBYTE( wsaData.wVersion ) != 0 )
623 /* Tell the user that we couldn't find a usable */
628 } /* The WinSock DLL is acceptable. Proceed. */
629 #elif defined(HAVE_WINSOCK)
631 if ( WSAStartup( 0x0101, &wsaData ) != 0 ) {
637 #if defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
639 char *name = ldap_int_hostname;
641 ldap_int_hostname = ldap_pvt_get_fqdn( name );
643 if ( name != NULL && name != ldap_int_hostname ) {
650 if ( ldap_int_tblsize == 0 ) ldap_int_ip_init();
653 ldap_int_initialize_global_options(gopts, NULL);
655 if( getenv("LDAPNOINIT") != NULL ) {
659 #ifdef HAVE_CYRUS_SASL
661 /* set authentication identity to current user name */
662 char *user = getenv("USER");
664 if( user == NULL ) user = getenv("USERNAME");
665 if( user == NULL ) user = getenv("LOGNAME");
668 gopts->ldo_def_sasl_authcid = LDAP_STRDUP( user );
673 openldap_ldap_init_w_sysconf(LDAP_CONF_FILE);
676 if ( geteuid() != getuid() )
680 openldap_ldap_init_w_userconf(LDAP_USERRC_FILE);
683 char *altfile = getenv(LDAP_ENV_PREFIX "CONF");
685 if( altfile != NULL ) {
686 Debug(LDAP_DEBUG_TRACE, "ldap_init: %s env is %s\n",
687 LDAP_ENV_PREFIX "CONF", altfile, 0);
688 openldap_ldap_init_w_sysconf( altfile );
691 Debug(LDAP_DEBUG_TRACE, "ldap_init: %s env is NULL\n",
692 LDAP_ENV_PREFIX "CONF", 0, 0);
696 char *altfile = getenv(LDAP_ENV_PREFIX "RC");
698 if( altfile != NULL ) {
699 Debug(LDAP_DEBUG_TRACE, "ldap_init: %s env is %s\n",
700 LDAP_ENV_PREFIX "RC", altfile, 0);
701 openldap_ldap_init_w_userconf( altfile );
704 Debug(LDAP_DEBUG_TRACE, "ldap_init: %s env is NULL\n",
705 LDAP_ENV_PREFIX "RC", 0, 0);
708 openldap_ldap_init_w_env(gopts, NULL);