2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2006 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>.
20 #include <ac/stdlib.h>
22 #include <ac/socket.h>
23 #include <ac/string.h>
28 #define LDAP_OPT_REBIND_PROC 0x4e814d
29 #define LDAP_OPT_REBIND_PARAMS 0x4e814e
31 #define LDAP_OPT_NEXTREF_PROC 0x4e815d
32 #define LDAP_OPT_NEXTREF_PARAMS 0x4e815e
34 #define LDAP_OPT_URLLIST_PROC 0x4e816d
35 #define LDAP_OPT_URLLIST_PARAMS 0x4e816e
37 static const LDAPAPIFeatureInfo features[] = {
38 #ifdef LDAP_API_FEATURE_X_OPENLDAP
39 { /* OpenLDAP Extensions API Feature */
40 LDAP_FEATURE_INFO_VERSION,
42 LDAP_API_FEATURE_X_OPENLDAP
46 #ifdef LDAP_API_FEATURE_THREAD_SAFE
47 { /* Basic Thread Safe */
48 LDAP_FEATURE_INFO_VERSION,
50 LDAP_API_FEATURE_THREAD_SAFE
53 #ifdef LDAP_API_FEATURE_SESSION_THREAD_SAFE
54 { /* Session Thread Safe */
55 LDAP_FEATURE_INFO_VERSION,
56 "SESSION_THREAD_SAFE",
57 LDAP_API_FEATURE_SESSION_THREAD_SAFE
60 #ifdef LDAP_API_FEATURE_OPERATION_THREAD_SAFE
61 { /* Operation Thread Safe */
62 LDAP_FEATURE_INFO_VERSION,
63 "OPERATION_THREAD_SAFE",
64 LDAP_API_FEATURE_OPERATION_THREAD_SAFE
67 #ifdef LDAP_API_FEATURE_X_OPENLDAP_REENTRANT
68 { /* OpenLDAP Reentrant */
69 LDAP_FEATURE_INFO_VERSION,
70 "X_OPENLDAP_REENTRANT",
71 LDAP_API_FEATURE_X_OPENLDAP_REENTRANT
74 #if defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) && \
75 defined( LDAP_THREAD_SAFE )
76 { /* OpenLDAP Thread Safe */
77 LDAP_FEATURE_INFO_VERSION,
78 "X_OPENLDAP_THREAD_SAFE",
79 LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE
82 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
84 LDAP_FEATURE_INFO_VERSION,
85 "X_OPENLDAP_V2_REFERRALS",
86 LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
98 struct ldapoptions *lo;
100 /* Get pointer to global option structure */
101 lo = LDAP_INT_GLOBAL_OPT();
103 return LDAP_NO_MEMORY;
106 if( lo->ldo_valid != LDAP_INITIALIZED ) {
107 ldap_int_initialize(lo, NULL);
111 assert( LDAP_VALID( ld ) );
113 if( !LDAP_VALID( ld ) ) {
114 return LDAP_OPT_ERROR;
117 lo = &ld->ld_options;
120 if(outvalue == NULL) {
121 /* no place to get to */
122 return LDAP_OPT_ERROR;
126 case LDAP_OPT_API_INFO: {
127 struct ldapapiinfo *info = (struct ldapapiinfo *) outvalue;
130 /* outvalue must point to an apiinfo structure */
131 return LDAP_OPT_ERROR;
134 if(info->ldapai_info_version != LDAP_API_INFO_VERSION) {
135 /* api info version mismatch */
136 info->ldapai_info_version = LDAP_API_INFO_VERSION;
137 return LDAP_OPT_ERROR;
140 info->ldapai_api_version = LDAP_API_VERSION;
141 info->ldapai_protocol_version = LDAP_VERSION_MAX;
143 if(features[0].ldapaif_name == NULL) {
144 info->ldapai_extensions = NULL;
147 info->ldapai_extensions = LDAP_MALLOC(sizeof(char *) *
148 sizeof(features)/sizeof(LDAPAPIFeatureInfo));
150 for(i=0; features[i].ldapaif_name != NULL; i++) {
151 info->ldapai_extensions[i] =
152 LDAP_STRDUP(features[i].ldapaif_name);
155 info->ldapai_extensions[i] = NULL;
158 info->ldapai_vendor_name = LDAP_STRDUP(LDAP_VENDOR_NAME);
159 info->ldapai_vendor_version = LDAP_VENDOR_VERSION;
161 return LDAP_OPT_SUCCESS;
165 if( ld == NULL || ld->ld_sb == NULL ) {
170 ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_GET_FD, outvalue );
171 return LDAP_OPT_SUCCESS;
173 case LDAP_OPT_SOCKBUF:
174 if( ld == NULL ) break;
175 *(Sockbuf **)outvalue = ld->ld_sb;
176 return LDAP_OPT_SUCCESS;
178 case LDAP_OPT_TIMEOUT:
179 /* the caller has to free outvalue ! */
180 if ( ldap_int_timeval_dup( outvalue, lo->ldo_tm_api) != 0 ) {
181 return LDAP_OPT_ERROR;
183 return LDAP_OPT_SUCCESS;
185 case LDAP_OPT_NETWORK_TIMEOUT:
186 /* the caller has to free outvalue ! */
187 if ( ldap_int_timeval_dup( outvalue, lo->ldo_tm_net ) != 0 ) {
188 return LDAP_OPT_ERROR;
190 return LDAP_OPT_SUCCESS;
193 * (int *) outvalue = lo->ldo_deref;
194 return LDAP_OPT_SUCCESS;
196 case LDAP_OPT_SIZELIMIT:
197 * (int *) outvalue = lo->ldo_sizelimit;
198 return LDAP_OPT_SUCCESS;
200 case LDAP_OPT_TIMELIMIT:
201 * (int *) outvalue = lo->ldo_timelimit;
202 return LDAP_OPT_SUCCESS;
204 case LDAP_OPT_REFERRALS:
205 * (int *) outvalue = (int) LDAP_BOOL_GET(lo, LDAP_BOOL_REFERRALS);
206 return LDAP_OPT_SUCCESS;
208 case LDAP_OPT_RESTART:
209 * (int *) outvalue = (int) LDAP_BOOL_GET(lo, LDAP_BOOL_RESTART);
210 return LDAP_OPT_SUCCESS;
212 case LDAP_OPT_PROTOCOL_VERSION:
213 * (int *) outvalue = lo->ldo_version;
214 return LDAP_OPT_SUCCESS;
216 case LDAP_OPT_SERVER_CONTROLS:
217 * (LDAPControl ***) outvalue =
218 ldap_controls_dup( lo->ldo_sctrls );
220 return LDAP_OPT_SUCCESS;
222 case LDAP_OPT_CLIENT_CONTROLS:
223 * (LDAPControl ***) outvalue =
224 ldap_controls_dup( lo->ldo_cctrls );
226 return LDAP_OPT_SUCCESS;
228 case LDAP_OPT_HOST_NAME:
229 * (char **) outvalue = ldap_url_list2hosts(lo->ldo_defludp);
230 return LDAP_OPT_SUCCESS;
233 * (char **) outvalue = ldap_url_list2urls(lo->ldo_defludp);
234 return LDAP_OPT_SUCCESS;
236 case LDAP_OPT_DEFBASE:
237 if( lo->ldo_defbase == NULL ) {
238 * (char **) outvalue = NULL;
240 * (char **) outvalue = LDAP_STRDUP(lo->ldo_defbase);
243 return LDAP_OPT_SUCCESS;
245 case LDAP_OPT_ERROR_NUMBER:
250 * (int *) outvalue = ld->ld_errno;
251 return LDAP_OPT_SUCCESS;
253 case LDAP_OPT_ERROR_STRING:
259 if( ld->ld_error == NULL ) {
260 * (char **) outvalue = NULL;
262 * (char **) outvalue = LDAP_STRDUP(ld->ld_error);
265 return LDAP_OPT_SUCCESS;
267 case LDAP_OPT_MATCHED_DN:
273 if( ld->ld_matched == NULL ) {
274 * (char **) outvalue = NULL;
276 * (char **) outvalue = LDAP_STRDUP( ld->ld_matched );
279 return LDAP_OPT_SUCCESS;
281 case LDAP_OPT_REFERRAL_URLS:
287 if( ld->ld_referrals == NULL ) {
288 * (char ***) outvalue = NULL;
290 * (char ***) outvalue = ldap_value_dup(ld->ld_referrals);
293 return LDAP_OPT_SUCCESS;
295 case LDAP_OPT_API_FEATURE_INFO: {
296 LDAPAPIFeatureInfo *info = (LDAPAPIFeatureInfo *) outvalue;
299 if(info == NULL) return LDAP_OPT_ERROR;
301 if(info->ldapaif_info_version != LDAP_FEATURE_INFO_VERSION) {
302 /* api info version mismatch */
303 info->ldapaif_info_version = LDAP_FEATURE_INFO_VERSION;
304 return LDAP_OPT_ERROR;
307 if(info->ldapaif_name == NULL) return LDAP_OPT_ERROR;
309 for(i=0; features[i].ldapaif_name != NULL; i++) {
310 if(!strcmp(info->ldapaif_name, features[i].ldapaif_name)) {
311 info->ldapaif_version =
312 features[i].ldapaif_version;
313 return LDAP_OPT_SUCCESS;
319 case LDAP_OPT_DEBUG_LEVEL:
320 * (int *) outvalue = lo->ldo_debug;
321 return LDAP_OPT_SUCCESS;
325 if ( ldap_pvt_tls_get_option( ld, option, outvalue ) == 0 ) {
326 return LDAP_OPT_SUCCESS;
329 #ifdef HAVE_CYRUS_SASL
330 if ( ldap_int_sasl_get_option( ld, option, outvalue ) == 0 ) {
331 return LDAP_OPT_SUCCESS;
338 return LDAP_OPT_ERROR;
345 LDAP_CONST void *invalue)
347 struct ldapoptions *lo;
350 /* Get pointer to global option structure */
351 lo = LDAP_INT_GLOBAL_OPT();
353 return LDAP_NO_MEMORY;
357 * The architecture to turn on debugging has a chicken and egg
358 * problem. Thus, we introduce a fix here.
361 if (option == LDAP_OPT_DEBUG_LEVEL) {
362 dbglvl = (int *) invalue;
365 if( lo->ldo_valid != LDAP_INITIALIZED ) {
366 ldap_int_initialize(lo, dbglvl);
370 assert( LDAP_VALID( ld ) );
372 if( !LDAP_VALID( ld ) ) {
373 return LDAP_OPT_ERROR;
376 lo = &ld->ld_options;
380 case LDAP_OPT_REFERRALS:
381 if(invalue == LDAP_OPT_OFF) {
382 LDAP_BOOL_CLR(lo, LDAP_BOOL_REFERRALS);
384 LDAP_BOOL_SET(lo, LDAP_BOOL_REFERRALS);
386 return LDAP_OPT_SUCCESS;
388 case LDAP_OPT_RESTART:
389 if(invalue == LDAP_OPT_OFF) {
390 LDAP_BOOL_CLR(lo, LDAP_BOOL_RESTART);
392 LDAP_BOOL_SET(lo, LDAP_BOOL_RESTART);
394 return LDAP_OPT_SUCCESS;
397 /* options which can withstand invalue == NULL */
399 case LDAP_OPT_SERVER_CONTROLS: {
400 LDAPControl *const *controls =
401 (LDAPControl *const *) invalue;
404 ldap_controls_free( lo->ldo_sctrls );
406 if( controls == NULL || *controls == NULL ) {
407 lo->ldo_sctrls = NULL;
408 return LDAP_OPT_SUCCESS;
411 lo->ldo_sctrls = ldap_controls_dup( controls );
413 if(lo->ldo_sctrls == NULL) {
414 /* memory allocation error ? */
417 } return LDAP_OPT_SUCCESS;
419 case LDAP_OPT_CLIENT_CONTROLS: {
420 LDAPControl *const *controls =
421 (LDAPControl *const *) invalue;
424 ldap_controls_free( lo->ldo_cctrls );
426 if( controls == NULL || *controls == NULL ) {
427 lo->ldo_cctrls = NULL;
428 return LDAP_OPT_SUCCESS;
431 lo->ldo_cctrls = ldap_controls_dup( controls );
433 if(lo->ldo_cctrls == NULL) {
434 /* memory allocation error ? */
437 } return LDAP_OPT_SUCCESS;
439 case LDAP_OPT_TIMEOUT: {
440 const struct timeval *tv =
441 (const struct timeval *) invalue;
443 if ( lo->ldo_tm_api != NULL ) {
444 LDAP_FREE( lo->ldo_tm_api );
445 lo->ldo_tm_api = NULL;
448 if ( ldap_int_timeval_dup( &lo->ldo_tm_api, tv ) != 0 ) {
449 return LDAP_OPT_ERROR;
451 } return LDAP_OPT_SUCCESS;
453 case LDAP_OPT_NETWORK_TIMEOUT: {
454 const struct timeval *tv =
455 (const struct timeval *) invalue;
457 if ( lo->ldo_tm_net != NULL ) {
458 LDAP_FREE( lo->ldo_tm_net );
459 lo->ldo_tm_net = NULL;
462 if ( ldap_int_timeval_dup( &lo->ldo_tm_net, tv ) != 0 ) {
463 return LDAP_OPT_ERROR;
465 } return LDAP_OPT_SUCCESS;
467 case LDAP_OPT_HOST_NAME: {
468 const char *host = (const char *) invalue;
469 LDAPURLDesc *ludlist = NULL;
470 int rc = LDAP_OPT_SUCCESS;
473 rc = ldap_url_parsehosts( &ludlist, host,
474 lo->ldo_defport ? lo->ldo_defport : LDAP_PORT );
476 } else if(ld == NULL) {
478 * must want global default returned
479 * to initial condition.
481 rc = ldap_url_parselist_ext(&ludlist, "ldap://localhost/", NULL,
482 LDAP_PVT_URL_PARSE_NOEMPTY_HOST
483 | LDAP_PVT_URL_PARSE_DEF_PORT );
487 * must want the session default
488 * updated to the current global default
490 ludlist = ldap_url_duplist(
491 ldap_int_global_options.ldo_defludp);
496 if (rc == LDAP_OPT_SUCCESS) {
497 if (lo->ldo_defludp != NULL)
498 ldap_free_urllist(lo->ldo_defludp);
499 lo->ldo_defludp = ludlist;
505 const char *urls = (const char *) invalue;
506 LDAPURLDesc *ludlist = NULL;
507 int rc = LDAP_OPT_SUCCESS;
510 rc = ldap_url_parselist_ext(&ludlist, urls, NULL,
511 LDAP_PVT_URL_PARSE_NOEMPTY_HOST
512 | LDAP_PVT_URL_PARSE_DEF_PORT );
513 } else if(ld == NULL) {
515 * must want global default returned
516 * to initial condition.
518 rc = ldap_url_parselist_ext(&ludlist, "ldap://localhost/", NULL,
519 LDAP_PVT_URL_PARSE_NOEMPTY_HOST
520 | LDAP_PVT_URL_PARSE_DEF_PORT );
524 * must want the session default
525 * updated to the current global default
527 ludlist = ldap_url_duplist(
528 ldap_int_global_options.ldo_defludp);
530 rc = LDAP_URL_ERR_MEM;
534 case LDAP_URL_SUCCESS: /* Success */
538 case LDAP_URL_ERR_MEM: /* can't allocate memory space */
542 case LDAP_URL_ERR_PARAM: /* parameter is bad */
543 case LDAP_URL_ERR_BADSCHEME: /* URL doesn't begin with "ldap[si]://" */
544 case LDAP_URL_ERR_BADENCLOSURE: /* URL is missing trailing ">" */
545 case LDAP_URL_ERR_BADURL: /* URL is bad */
546 case LDAP_URL_ERR_BADHOST: /* host port is bad */
547 case LDAP_URL_ERR_BADATTRS: /* bad (or missing) attributes */
548 case LDAP_URL_ERR_BADSCOPE: /* scope string is invalid (or missing) */
549 case LDAP_URL_ERR_BADFILTER: /* bad or missing filter */
550 case LDAP_URL_ERR_BADEXTS: /* bad or missing extensions */
551 rc = LDAP_PARAM_ERROR;
555 if (rc == LDAP_SUCCESS) {
556 if (lo->ldo_defludp != NULL)
557 ldap_free_urllist(lo->ldo_defludp);
558 lo->ldo_defludp = ludlist;
563 case LDAP_OPT_DEFBASE: {
564 const char *newbase = (const char *) invalue;
565 char *defbase = NULL;
567 if ( newbase != NULL ) {
568 defbase = LDAP_STRDUP( newbase );
569 if ( defbase == NULL ) return LDAP_NO_MEMORY;
571 } else if ( ld != NULL ) {
572 defbase = LDAP_STRDUP( ldap_int_global_options.ldo_defbase );
573 if ( defbase == NULL ) return LDAP_NO_MEMORY;
576 if ( lo->ldo_defbase != NULL )
577 LDAP_FREE( lo->ldo_defbase );
578 lo->ldo_defbase = defbase;
579 } return LDAP_OPT_SUCCESS;
581 case LDAP_OPT_ERROR_STRING: {
582 const char *err = (const char *) invalue;
585 /* need a struct ldap */
586 return LDAP_OPT_ERROR;
590 LDAP_FREE(ld->ld_error);
595 ld->ld_error = LDAP_STRDUP(err);
597 } return LDAP_OPT_SUCCESS;
599 case LDAP_OPT_MATCHED_DN: {
600 const char *matched = (const char *) invalue;
603 /* need a struct ldap */
604 return LDAP_OPT_ERROR;
607 if( ld->ld_matched ) {
608 LDAP_FREE(ld->ld_matched);
609 ld->ld_matched = NULL;
613 ld->ld_matched = LDAP_STRDUP( matched );
615 } return LDAP_OPT_SUCCESS;
617 case LDAP_OPT_REFERRAL_URLS: {
618 char *const *referrals = (char *const *) invalue;
621 /* need a struct ldap */
622 return LDAP_OPT_ERROR;
625 if( ld->ld_referrals ) {
626 LDAP_VFREE(ld->ld_referrals);
630 ld->ld_referrals = ldap_value_dup(referrals);
632 } return LDAP_OPT_SUCCESS;
634 /* Only accessed from inside this function by ldap_set_rebind_proc() */
635 case LDAP_OPT_REBIND_PROC: {
636 lo->ldo_rebind_proc = (LDAP_REBIND_PROC *)invalue;
637 } return LDAP_OPT_SUCCESS;
638 case LDAP_OPT_REBIND_PARAMS: {
639 lo->ldo_rebind_params = (void *)invalue;
640 } return LDAP_OPT_SUCCESS;
642 /* Only accessed from inside this function by ldap_set_nextref_proc() */
643 case LDAP_OPT_NEXTREF_PROC: {
644 lo->ldo_nextref_proc = (LDAP_NEXTREF_PROC *)invalue;
645 } return LDAP_OPT_SUCCESS;
646 case LDAP_OPT_NEXTREF_PARAMS: {
647 lo->ldo_nextref_params = (void *)invalue;
648 } return LDAP_OPT_SUCCESS;
650 /* Only accessed from inside this function by ldap_set_urllist_proc() */
651 case LDAP_OPT_URLLIST_PROC: {
652 lo->ldo_urllist_proc = (LDAP_URLLIST_PROC *)invalue;
653 } return LDAP_OPT_SUCCESS;
654 case LDAP_OPT_URLLIST_PARAMS: {
655 lo->ldo_urllist_params = (void *)invalue;
656 } return LDAP_OPT_SUCCESS;
658 /* read-only options */
659 case LDAP_OPT_API_INFO:
661 case LDAP_OPT_API_FEATURE_INFO:
662 return LDAP_OPT_ERROR;
664 /* options which cannot withstand invalue == NULL */
666 case LDAP_OPT_SIZELIMIT:
667 case LDAP_OPT_TIMELIMIT:
668 case LDAP_OPT_PROTOCOL_VERSION:
669 case LDAP_OPT_ERROR_NUMBER:
670 case LDAP_OPT_DEBUG_LEVEL:
671 if(invalue == NULL) {
672 /* no place to set from */
673 return LDAP_OPT_ERROR;
679 if ( ldap_pvt_tls_set_option( ld, option, (void *)invalue ) == 0 )
680 return LDAP_OPT_SUCCESS;
682 #ifdef HAVE_CYRUS_SASL
683 if ( ldap_int_sasl_set_option( ld, option, (void *)invalue ) == 0 )
684 return LDAP_OPT_SUCCESS;
687 return LDAP_OPT_ERROR;
690 /* options which cannot withstand invalue == NULL */
694 lo->ldo_deref = * (const int *) invalue;
695 return LDAP_OPT_SUCCESS;
697 case LDAP_OPT_SIZELIMIT:
698 lo->ldo_sizelimit = * (const int *) invalue;
699 return LDAP_OPT_SUCCESS;
701 case LDAP_OPT_TIMELIMIT:
702 lo->ldo_timelimit = * (const int *) invalue;
703 return LDAP_OPT_SUCCESS;
705 case LDAP_OPT_PROTOCOL_VERSION: {
706 int vers = * (const int *) invalue;
707 if (vers < LDAP_VERSION_MIN || vers > LDAP_VERSION_MAX) {
711 lo->ldo_version = vers;
712 } return LDAP_OPT_SUCCESS;
714 case LDAP_OPT_ERROR_NUMBER: {
715 int err = * (const int *) invalue;
718 /* need a struct ldap */
723 } return LDAP_OPT_SUCCESS;
725 case LDAP_OPT_DEBUG_LEVEL:
726 lo->ldo_debug = * (const int *) invalue;
727 return LDAP_OPT_SUCCESS;
729 return LDAP_OPT_ERROR;
733 ldap_set_rebind_proc( LDAP *ld, LDAP_REBIND_PROC *proc, void *params )
736 rc = ldap_set_option( ld, LDAP_OPT_REBIND_PROC, (void *)proc );
737 if( rc != LDAP_OPT_SUCCESS ) return rc;
739 rc = ldap_set_option( ld, LDAP_OPT_REBIND_PARAMS, (void *)params );
744 ldap_set_nextref_proc( LDAP *ld, LDAP_NEXTREF_PROC *proc, void *params )
747 rc = ldap_set_option( ld, LDAP_OPT_NEXTREF_PROC, (void *)proc );
748 if( rc != LDAP_OPT_SUCCESS ) return rc;
750 rc = ldap_set_option( ld, LDAP_OPT_NEXTREF_PARAMS, (void *)params );
755 ldap_set_urllist_proc( LDAP *ld, LDAP_URLLIST_PROC *proc, void *params )
758 rc = ldap_set_option( ld, LDAP_OPT_URLLIST_PROC, (void *)proc );
759 if( rc != LDAP_OPT_SUCCESS ) return rc;
761 rc = ldap_set_option( ld, LDAP_OPT_URLLIST_PARAMS, (void *)params );