2 * Copyright (c) 1996 Regents of the University of Michigan.
5 * Redistribution and use in source and binary forms are permitted
6 * provided that this notice is preserved and that due credit is given
7 * to the University of Michigan at Ann Arbor. The name of the University
8 * may not be used to endorse or promote products derived from this
9 * software without specific prior written permission. This software
10 * is provided ``as is'' without express or implied warranty.
14 * ldap_op.c - routines to perform LDAP operations
22 #include <ac/string.h>
33 /* Forward references */
34 static struct berval **make_singlevalued_berval LDAP_P(( char *, int ));
35 static int op_ldap_add LDAP_P(( Ri *, Re *, char ** ));
36 static int op_ldap_modify LDAP_P(( Ri *, Re *, char ** ));
37 static int op_ldap_delete LDAP_P(( Ri *, Re *, char ** ));
38 static int op_ldap_modrdn LDAP_P(( Ri *, Re *, char ** ));
39 static LDAPMod *alloc_ldapmod LDAP_P(());
40 static void free_ldapmod LDAP_P(( LDAPMod * ));
41 static void free_ldmarr LDAP_P(( LDAPMod ** ));
42 static int getmodtype LDAP_P(( char * ));
43 static void dump_ldm_array LDAP_P(( LDAPMod ** ));
44 static char **read_krbnames LDAP_P(( Ri * ));
45 static void upcase LDAP_P(( char * ));
46 static int do_bind LDAP_P(( Ri *, int * ));
47 static int do_unbind LDAP_P(( Ri * ));
50 static char *kattrs[] = {"kerberosName", NULL };
51 static struct timeval kst = {30L, 0L};
56 * Determine the type of ldap operation being performed and call the
57 * appropriate routine.
58 * - If successful, returns ERR_DO_LDAP_OK
59 * - If a retryable error occurs, ERR_DO_LDAP_RETRYABLE is returned.
60 * The caller should wait a while and retry the operation.
61 * - If a fatal error occurs, ERR_DO_LDAP_FATAL is returned. The caller
62 * should reject the operation and continue with the next replication
73 int lderr = LDAP_SUCCESS;
79 if ( ri->ri_ldp == NULL ) {
80 rc = do_bind( ri, &lderr );
81 if ( rc != BIND_OK ) {
82 return DO_LDAP_ERR_RETRYABLE;
86 switch ( re->re_changetype ) {
88 lderr = op_ldap_add( ri, re, errmsg );
89 if ( lderr != LDAP_SUCCESS ) {
90 Debug( LDAP_DEBUG_ANY,
91 "Error: ldap_add_s failed adding \"%s\": %s\n",
92 *errmsg ? *errmsg : ldap_err2string( lderr ),
97 lderr = op_ldap_modify( ri, re, errmsg );
98 if ( lderr != LDAP_SUCCESS ) {
99 Debug( LDAP_DEBUG_ANY,
100 "Error: ldap_modify_s failed modifying \"%s\": %s\n",
101 *errmsg ? *errmsg : ldap_err2string( lderr ),
106 lderr = op_ldap_delete( ri, re, errmsg );
107 if ( lderr != LDAP_SUCCESS ) {
108 Debug( LDAP_DEBUG_ANY,
109 "Error: ldap_delete_s failed deleting \"%s\": %s\n",
110 *errmsg ? *errmsg : ldap_err2string( lderr ),
115 lderr = op_ldap_modrdn( ri, re, errmsg );
116 if ( lderr != LDAP_SUCCESS ) {
117 Debug( LDAP_DEBUG_ANY,
118 "Error: ldap_modrdn_s failed modifying %s: %s\n",
119 *errmsg ? *errmsg : ldap_err2string( lderr ),
124 Debug( LDAP_DEBUG_ANY,
125 "Error: do_ldap: bad op \"%d\", dn = \"%s\"\n",
126 re->re_changetype, re->re_dn, 0 );
127 return DO_LDAP_ERR_FATAL;
131 * Analyze return code. If ok, just return. If LDAP_SERVER_DOWN,
132 * we may have been idle long enough that the remote slapd timed
133 * us out. Rebind and try again.
135 if ( lderr == LDAP_SUCCESS ) {
137 } else if ( lderr == LDAP_SERVER_DOWN ) {
138 /* The LDAP server may have timed us out - rebind and try again */
139 (void) do_unbind( ri );
142 return DO_LDAP_ERR_FATAL;
145 return DO_LDAP_ERR_FATAL;
152 * Perform an ldap add operation.
162 int nattrs, rc = 0, i;
163 LDAPMod *ldm, **ldmarr;
170 * Construct a null-terminated array of LDAPMod structs.
173 while ( mi[ i ].mi_type != NULL ) {
174 ldm = alloc_ldapmod();
175 ldmarr = ( LDAPMod ** ) ch_realloc( ldmarr,
176 ( nattrs + 2 ) * sizeof( LDAPMod * ));
177 ldmarr[ nattrs ] = ldm;
178 ldm->mod_op = LDAP_MOD_BVALUES;
179 ldm->mod_type = mi[ i ].mi_type;
181 make_singlevalued_berval( mi[ i ].mi_val, mi[ i ].mi_len );
186 if ( ldmarr != NULL ) {
187 ldmarr[ nattrs ] = NULL;
189 /* Perform the operation */
190 Debug( LDAP_DEBUG_ARGS, "replica %s:%d - add dn \"%s\"\n",
191 ri->ri_hostname, ri->ri_port, re->re_dn );
192 rc = ldap_add_s( ri->ri_ldp, re->re_dn, ldmarr );
194 ldap_get_option( ri->ri_ldp, LDAP_OPT_ERROR_NUMBER, &lderr);
197 *errmsg = "No modifications to do";
198 Debug( LDAP_DEBUG_ANY,
199 "Error: op_ldap_add: no mods to do (%s)!", re->re_dn, 0, 0 );
201 free_ldmarr( ldmarr );
209 * Perform an ldap modify operation.
211 #define AWAITING_OP -1
220 int state; /* This code is a simple-minded state machine */
221 int nvals; /* Number of values we're modifying */
222 int nops; /* Number of LDAPMod structs in ldmarr */
223 LDAPMod *ldm, **ldmarr;
233 if ( re->re_mods == NULL ) {
234 *errmsg = "No arguments given";
235 Debug( LDAP_DEBUG_ANY, "Error: op_ldap_modify: no arguments\n",
241 * Construct a null-terminated array of LDAPMod structs.
243 for ( mi = re->re_mods, i = 0; mi[ i ].mi_type != NULL; i++ ) {
244 type = mi[ i ].mi_type;
245 value = mi[ i ].mi_val;
246 len = mi[ i ].mi_len;
247 switch ( getmodtype( type )) {
249 state = T_MODSEP; /* Got a separator line "-\n" */
253 ldmarr = ( LDAPMod ** )
254 ch_realloc(ldmarr, (( nops + 2 ) * ( sizeof( LDAPMod * ))));
255 ldmarr[ nops ] = ldm = alloc_ldapmod();
256 ldm->mod_op = LDAP_MOD_ADD | LDAP_MOD_BVALUES;
257 ldm->mod_type = value;
262 state = T_MODOPREPLACE;
263 ldmarr = ( LDAPMod ** )
264 ch_realloc(ldmarr, (( nops + 2 ) * ( sizeof( LDAPMod * ))));
265 ldmarr[ nops ] = ldm = alloc_ldapmod();
266 ldm->mod_op = LDAP_MOD_REPLACE | LDAP_MOD_BVALUES;
267 ldm->mod_type = value;
272 state = T_MODOPDELETE;
273 ldmarr = ( LDAPMod ** )
274 ch_realloc(ldmarr, (( nops + 2 ) * ( sizeof( LDAPMod * ))));
275 ldmarr[ nops ] = ldm = alloc_ldapmod();
276 ldm->mod_op = LDAP_MOD_DELETE | LDAP_MOD_BVALUES;
277 ldm->mod_type = value;
282 if ( state == AWAITING_OP ) {
283 Debug( LDAP_DEBUG_ANY,
284 "Error: op_ldap_modify: unknown mod type \"%s\"\n",
290 * We should have an attribute: value pair here.
291 * Construct the mod_bvalues part of the ldapmod struct.
293 if ( strcasecmp( type, ldm->mod_type )) {
294 Debug( LDAP_DEBUG_ANY,
295 "Error: malformed modify op, %s: %s (expecting %s:)\n",
296 type, value, ldm->mod_type );
299 ldm->mod_bvalues = ( struct berval ** )
300 ch_realloc( ldm->mod_bvalues,
301 ( nvals + 2 ) * sizeof( struct berval * ));
302 ldm->mod_bvalues[ nvals + 1 ] = NULL;
303 ldm->mod_bvalues[ nvals ] = ( struct berval * )
304 ch_malloc( sizeof( struct berval ));
305 ldm->mod_bvalues[ nvals ]->bv_val = value;
306 ldm->mod_bvalues[ nvals ]->bv_len = len;
310 ldmarr[ nops ] = NULL;
313 /* Actually perform the LDAP operation */
314 Debug( LDAP_DEBUG_ARGS, "replica %s:%d - modify dn \"%s\"\n",
315 ri->ri_hostname, ri->ri_port, re->re_dn );
316 rc = ldap_modify_s( ri->ri_ldp, re->re_dn, ldmarr );
318 free_ldmarr( ldmarr );
326 * Perform an ldap delete operation.
337 Debug( LDAP_DEBUG_ARGS, "replica %s:%d - delete dn \"%s\"\n",
338 ri->ri_hostname, ri->ri_port, re->re_dn );
339 rc = ldap_delete_s( ri->ri_ldp, re->re_dn );
348 * Perform an ldap modrdn operation.
351 #define GOT_DRDNFLAGSTR 2
352 #define GOT_ALLNEWRDNFLAGS ( GOT_NEWRDN | GOT_DRDNFLAGSTR )
368 if ( re->re_mods == NULL ) {
369 *errmsg = "No arguments given";
370 Debug( LDAP_DEBUG_ANY, "Error: op_ldap_modrdn: no arguments\n",
376 * Get the arguments: should see newrdn: and deleteoldrdn: args.
378 for ( mi = re->re_mods, i = 0; mi[ i ].mi_type != NULL; i++ ) {
379 if ( !strcmp( mi[ i ].mi_type, T_NEWRDNSTR )) {
380 newrdn = mi[ i ].mi_val;
382 } else if ( !strcmp( mi[ i ].mi_type, T_DRDNFLAGSTR )) {
383 state |= GOT_DRDNFLAGSTR;
384 if ( !strcmp( mi[ i ].mi_val, "0" )) {
386 } else if ( !strcmp( mi[ i ].mi_val, "1" )) {
389 Debug( LDAP_DEBUG_ANY,
390 "Error: op_ldap_modrdn: bad deleteoldrdn arg \"%s\"\n",
391 mi[ i ].mi_val, 0, 0 );
392 *errmsg = "Incorrect argument to deleteoldrdn";
396 Debug( LDAP_DEBUG_ANY, "Error: op_ldap_modrdn: bad type \"%s\"\n",
397 mi[ i ].mi_type, 0, 0 );
398 *errmsg = "Bad value in replication log entry";
404 * Punt if we don't have all the args.
406 if ( state != GOT_ALLNEWRDNFLAGS ) {
407 Debug( LDAP_DEBUG_ANY, "Error: op_ldap_modrdn: missing arguments\n",
409 *errmsg = "Missing argument: requires \"newrdn\" and \"deleteoldrdn\"";
414 if ( ldap_debug & LDAP_DEBUG_ARGS ) {
417 sprintf( buf, "%s:%d", ri->ri_hostname, ri->ri_port );
418 buf2 = (char *) ch_malloc( strlen( re->re_dn ) + strlen( mi->mi_val )
420 sprintf( buf2, "(\"%s\" -> \"%s\")", re->re_dn, mi->mi_val );
421 Debug( LDAP_DEBUG_ARGS,
422 "replica %s - modify rdn %s (flag: %d)\n",
423 buf, buf2, drdnflag );
426 #endif /* LDAP_DEBUG */
429 rc = ldap_modrdn2_s( ri->ri_ldp, re->re_dn, mi->mi_val, drdnflag );
431 ldap_get_option( ri->ri_ldp, LDAP_OPT_ERROR_NUMBER, &lderr);
438 * Allocate and initialize an ldapmod struct.
445 ldm = ( struct ldapmod * ) ch_malloc( sizeof ( struct ldapmod ));
446 ldm->mod_type = NULL;
447 ldm->mod_bvalues = ( struct berval ** ) NULL;
454 * Free an ldapmod struct associated mod_bvalues. NOTE - it is assumed
455 * that mod_bvalues and mod_type contain pointers to the same block of memory
456 * pointed to by the repl struct. Therefore, it's not freed here.
467 if ( ldm->mod_bvalues != NULL ) {
468 for ( i = 0; ldm->mod_bvalues[ i ] != NULL; i++ ) {
469 free( ldm->mod_bvalues[ i ] );
471 free( ldm->mod_bvalues );
479 * Free an an array of LDAPMod pointers and the LDAPMod structs they point
488 for ( i = 0; ldmarr[ i ] != NULL; i++ ) {
489 free_ldapmod( ldmarr[ i ] );
496 * Create a berval with a single value.
498 static struct berval **
499 make_singlevalued_berval(
505 p = ( struct berval ** ) ch_malloc( 2 * sizeof( struct berval * ));
506 p[ 0 ] = ( struct berval * ) ch_malloc( sizeof( struct berval ));
508 p[ 0 ]->bv_val = value;
509 p[ 0 ]->bv_len = len;
515 * Given a modification type (string), return an enumerated type.
516 * Avoids ugly copy in op_ldap_modify - lets us use a switch statement
523 if ( !strcmp( type, T_MODSEPSTR )) {
526 if ( !strcmp( type, T_MODOPADDSTR )) {
527 return( T_MODOPADD );
529 if ( !strcmp( type, T_MODOPREPLACESTR )) {
530 return( T_MODOPREPLACE );
532 if ( !strcmp( type, T_MODOPDELETESTR )) {
533 return( T_MODOPDELETE );
540 * Perform an LDAP unbind operation. If replica is NULL, or the
541 * repl_ldp is NULL, just return LDAP_SUCCESS. Otherwise, unbind,
542 * set the ldp to NULL, and return the result of the unbind call.
549 int rc = LDAP_SUCCESS;
551 if (( ri != NULL ) && ( ri->ri_ldp != NULL )) {
552 rc = ldap_unbind( ri->ri_ldp );
553 if ( rc != LDAP_SUCCESS ) {
554 Debug( LDAP_DEBUG_ANY,
555 "Error: do_unbind: ldap_unbind failed for %s:%d: %s\n",
556 ldap_err2string( rc ), ri->ri_hostname, ri->ri_port );
566 * Perform an LDAP bind operation to the replication site given
567 * by replica. If replica->repl_ldp is non-NULL, then we unbind
568 * from the replica before rebinding. It should be safe to call
569 * this to re-connect if the replica's connection goes away
572 * Returns 0 on success, -1 if an LDAP error occurred, and a return
573 * code > 0 if some other error occurred, e.g. invalid bind method.
574 * If an LDAP error occurs, the LDAP error is returned in lderr.
588 char *skrbnames[ 2 ];
589 char realm[ REALM_SZ ];
590 char name[ ANAME_SZ ];
591 char instance[ INST_SZ ];
592 #endif /* HAVE_KERBEROS */
597 Debug( LDAP_DEBUG_ANY, "Error: do_bind: null ri ptr\n", 0, 0, 0 );
598 return( BIND_ERR_BADRI );
601 if ( ri->ri_ldp != NULL ) {
602 ldrc = ldap_unbind( ri->ri_ldp );
603 if ( ldrc != LDAP_SUCCESS ) {
604 Debug( LDAP_DEBUG_ANY,
605 "Error: do_bind: ldap_unbind failed: %s\n",
606 ldap_err2string( ldrc ), 0, 0 );
611 Debug( LDAP_DEBUG_ARGS, "Open connection to %s:%d\n",
612 ri->ri_hostname, ri->ri_port, 0 );
613 ri->ri_ldp = ldap_open( ri->ri_hostname, ri->ri_port );
614 if ( ri->ri_ldp == NULL ) {
615 Debug( LDAP_DEBUG_ANY, "Error: ldap_open(%s, %d) failed: %s\n",
616 ri->ri_hostname, ri->ri_port, sys_errlist[ errno ] );
617 return( BIND_ERR_OPEN );
621 * Disable string translation if enabled by default.
622 * The replication log is written in the internal format,
623 * so this would do another translation, breaking havoc.
625 #if defined( STR_TRANSLATION ) && defined( LDAP_DEFAULT_CHARSET )
626 ri->ri_ldp->ld_lberoptions &= ~LBER_TRANSLATE_STRINGS;
627 #endif /* STR_TRANSLATION && LDAP_DEFAULT_CHARSET */
630 * Set ldap library options to (1) not follow referrals, and
631 * (2) restart the select() system call.
633 ldap_set_option(ri->ri_ldp, LDAP_OPT_REFERRALS, LDAP_OPT_OFF);
634 ldap_set_option(ri->ri_ldp, LDAP_OPT_RESTART, LDAP_OPT_ON);
636 switch ( ri->ri_bind_method ) {
638 #ifndef HAVE_KERBEROS
639 Debug( LDAP_DEBUG_ANY,
640 "Error: Kerberos bind for %s:%d, but not compiled w/kerberos\n",
641 ri->ri_hostname, ri->ri_port, 0 );
642 return( BIND_ERR_KERBEROS_FAILED );
643 #else /* HAVE_KERBEROS */
645 * Bind using kerberos.
646 * If "bindprincipal" was given in the config file, then attempt
647 * to get a TGT for that principal (via the srvtab file). If only
648 * a binddn was given, then we need to read that entry to get
649 * the kerberosName attributes, and try to get a TGT for one
650 * of them. All are tried. The first one which succeeds is
651 * returned. XXX It might be a good idea to just require a
652 * bindprincipal. Reading the entry every time might be a significant
653 * amount of overhead, if the connection is closed between most
657 if ( ri->ri_principal != NULL ) {
658 skrbnames[ 0 ] = ri->ri_principal;
659 skrbnames[ 1 ] = NULL;
660 krbnames = skrbnames;
662 krbnames = read_krbnames( ri );
665 if (( krbnames == NULL ) || ( krbnames[ 0 ] == NULL )) {
666 Debug( LDAP_DEBUG_ANY,
667 "Error: Can't find krbname for binddn \"%s\"\n",
668 ri->ri_bind_dn, 0, 0 );
669 retval = BIND_ERR_KERBEROS_FAILED;
673 * Now we've got one or more kerberos principals. See if any
674 * of them are in the srvtab file.
677 for ( kni = 0; krbnames[ kni ] != NULL; kni++ ) {
678 rc = kname_parse( name, instance, realm, krbnames[ kni ]);
679 if ( rc != KSUCCESS ) {
683 rc = krb_get_svc_in_tkt( name, instance, realm, "krbtgt", realm,
685 if ( rc != KSUCCESS) {
686 Debug( LDAP_DEBUG_ANY, "Error: Can't get TGT for %s: %s\n",
687 krbnames[ kni ], krb_err_txt[ rc ], 0 );
694 Debug( LDAP_DEBUG_ANY,
695 "Error: Could not obtain TGT for DN \"%s\"\n",
696 ri->ri_bind_dn, 0, 0 );
697 retval = BIND_ERR_KERBEROS_FAILED;
701 * We've got a TGT. Do a kerberos bind.
703 Debug( LDAP_DEBUG_ARGS, "bind to %s:%d as %s (kerberos)\n",
704 ri->ri_hostname, ri->ri_port, ri->ri_bind_dn );
705 ldrc = ldap_kerberos_bind_s( ri->ri_ldp, ri->ri_bind_dn );
706 ri->ri_principal = strdup( krbnames[ kni ] );
707 if ( ldrc != LDAP_SUCCESS ) {
708 Debug( LDAP_DEBUG_ANY, "Error: kerberos bind for %s:%dfailed: %s\n",
709 ri->ri_hostname, ri->ri_port, ldap_err2string( ldrc ));
711 retval = BIND_ERR_KERBEROS_FAILED;
714 kexit: if ( krbnames != NULL ) {
715 ldap_value_free( krbnames );
719 #endif /* HAVE_KERBEROS */
722 * Bind with a plaintext password.
724 Debug( LDAP_DEBUG_ARGS, "bind to %s:%d as %s (simple)\n",
725 ri->ri_hostname, ri->ri_port, ri->ri_bind_dn );
726 ldrc = ldap_simple_bind_s( ri->ri_ldp, ri->ri_bind_dn,
728 if ( ldrc != LDAP_SUCCESS ) {
729 Debug( LDAP_DEBUG_ANY,
730 "Error: ldap_simple_bind_s for %s:%d failed: %s\n",
731 ri->ri_hostname, ri->ri_port, ldap_err2string( ldrc ));
733 return( BIND_ERR_SIMPLE_FAILED );
739 Debug( LDAP_DEBUG_ANY,
740 "Error: do_bind: unknown auth type \"%d\" for %s:%d\n",
741 ri->ri_bind_method, ri->ri_hostname, ri->ri_port );
742 return( BIND_ERR_BAD_ATYPE );
751 * For debugging. Print the contents of an ldmarr array.
762 for ( i = 0; ldmarr[ i ] != NULL; i++ ) {
764 Debug( LDAP_DEBUG_TRACE,
765 "Trace (%d): *** ldmarr[ %d ] contents:\n",
767 Debug( LDAP_DEBUG_TRACE,
768 "Trace (%d): *** ldm->mod_op: %d\n",
769 getpid(), ldm->mod_op, 0 );
770 Debug( LDAP_DEBUG_TRACE,
771 "Trace (%d): *** ldm->mod_type: %s\n",
772 getpid(), ldm->mod_type, 0 );
773 if ( ldm->mod_bvalues != NULL ) {
774 for ( j = 0; ( b = ldm->mod_bvalues[ j ] ) != NULL; j++ ) {
775 msgbuf = ch_malloc( b->bv_len + 512 );
776 sprintf( msgbuf, "***** bv[ %d ] len = %ld, val = <%s>",
777 j, b->bv_len, b->bv_val );
778 Debug( LDAP_DEBUG_TRACE,
779 "Trace (%d):%s\n", getpid(), msgbuf, 0 );
788 * Get the kerberos names from the binddn for "replica" via an ldap search.
789 * Returns a null-terminated array of char *, or NULL if the entry could
790 * not be found or there were no kerberosName attributes. The caller is
791 * responsible for freeing the returned array and strings it points to.
801 LDAPMessage *result, *entry;
803 /* First need to bind as NULL */
804 rc = ldap_simple_bind_s( ri->ri_ldp, NULL, NULL );
805 if ( rc != LDAP_SUCCESS ) {
806 Debug( LDAP_DEBUG_ANY,
807 "Error: null bind failed getting krbnames for %s:%d: %s\n",
808 ri->ri_hostname, ri->ri_port, ldap_err2string( rc ));
811 rc = ldap_search_st( ri->ri_ldp, ri->ri_bind_dn, LDAP_SCOPE_BASE,
812 "objectclass=*", kattrs, 0, &kst, &result );
813 if ( rc != LDAP_SUCCESS ) {
814 Debug( LDAP_DEBUG_ANY,
815 "Error: search failed getting krbnames for %s:%d: %s\n",
816 ri->ri_hostname, ri->ri_port, ldap_err2string( rc ));
819 ne = ldap_count_entries( ri->ri_ldp, result );
821 Debug( LDAP_DEBUG_ANY,
822 "Error: Can't find entry \"%s\" for %s:%d kerberos bind\n",
823 ri->ri_bind_dn, ri->ri_hostname, ri->ri_port );
827 Debug( LDAP_DEBUG_ANY,
828 "Error: Kerberos binddn \"%s\" for %s:%dis ambiguous\n",
829 ri->ri_bind_dn, ri->ri_hostname, ri->ri_port );
832 entry = ldap_first_entry( ri->ri_ldp, result );
833 if ( entry == NULL ) {
834 Debug( LDAP_DEBUG_ANY,
835 "Error: Can't find \"%s\" for kerberos binddn for %s:%d\n",
836 ri->ri_bind_dn, ri->ri_hostname, ri->ri_port );
839 krbnames = ldap_get_values( ri->ri_ldp, entry, "kerberosName" );
840 ldap_msgfree( result );
855 for ( p = s; ( p != NULL ) && ( *p != '\0' ); p++ ) {
856 *p = TOUPPER( (unsigned char) *p );