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>
32 /* Forward references */
33 static int get_changetype LDAP_P(( char * ));
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 /* External references */
51 extern char *ch_malloc LDAP_P(( unsigned long ));
53 static char *kattrs[] = {"kerberosName", NULL };
54 static struct timeval kst = {30L, 0L};
59 * Determine the type of ldap operation being performed and call the
60 * appropriate routine.
61 * - If successful, returns ERR_DO_LDAP_OK
62 * - If a retryable error occurs, ERR_DO_LDAP_RETRYABLE is returned.
63 * The caller should wait a while and retry the operation.
64 * - If a fatal error occurs, ERR_DO_LDAP_FATAL is returned. The caller
65 * should reject the operation and continue with the next replication
76 int lderr = LDAP_SUCCESS;
83 if ( ri->ri_ldp == NULL ) {
84 rc = do_bind( ri, &lderr );
85 if ( rc != BIND_OK ) {
86 return DO_LDAP_ERR_RETRYABLE;
90 switch ( re->re_changetype ) {
92 lderr = op_ldap_add( ri, re, errmsg );
93 if ( lderr != LDAP_SUCCESS ) {
94 Debug( LDAP_DEBUG_ANY,
95 "Error: ldap_add_s failed adding \"%s\": %s\n",
96 *errmsg ? *errmsg : ldap_err2string( lderr ),
101 lderr = op_ldap_modify( ri, re, errmsg );
102 if ( lderr != LDAP_SUCCESS ) {
103 Debug( LDAP_DEBUG_ANY,
104 "Error: ldap_modify_s failed modifying \"%s\": %s\n",
105 *errmsg ? *errmsg : ldap_err2string( lderr ),
110 lderr = op_ldap_delete( ri, re, errmsg );
111 if ( lderr != LDAP_SUCCESS ) {
112 Debug( LDAP_DEBUG_ANY,
113 "Error: ldap_delete_s failed deleting \"%s\": %s\n",
114 *errmsg ? *errmsg : ldap_err2string( lderr ),
119 lderr = op_ldap_modrdn( ri, re, errmsg );
120 if ( lderr != LDAP_SUCCESS ) {
121 Debug( LDAP_DEBUG_ANY,
122 "Error: ldap_modrdn_s failed modifying %s: %s\n",
123 *errmsg ? *errmsg : ldap_err2string( lderr ),
128 Debug( LDAP_DEBUG_ANY,
129 "Error: do_ldap: bad op \"%d\", dn = \"%s\"\n",
130 re->re_changetype, re->re_dn, 0 );
131 return DO_LDAP_ERR_FATAL;
135 * Analyze return code. If ok, just return. If LDAP_SERVER_DOWN,
136 * we may have been idle long enough that the remote slapd timed
137 * us out. Rebind and try again.
139 if ( lderr == LDAP_SUCCESS ) {
141 } else if ( lderr == LDAP_SERVER_DOWN ) {
142 /* The LDAP server may have timed us out - rebind and try again */
143 (void) do_unbind( ri );
146 return DO_LDAP_ERR_FATAL;
149 return DO_LDAP_ERR_FATAL;
156 * Perform an ldap add operation.
166 int nattrs, rc = 0, i;
167 LDAPMod *ldm, **ldmarr;
174 * Construct a null-terminated array of LDAPMod structs.
177 while ( mi[ i ].mi_type != NULL ) {
178 ldm = alloc_ldapmod();
179 ldmarr = ( LDAPMod ** ) ch_realloc( ldmarr,
180 ( nattrs + 2 ) * sizeof( LDAPMod * ));
181 ldmarr[ nattrs ] = ldm;
182 ldm->mod_op = LDAP_MOD_BVALUES;
183 ldm->mod_type = mi[ i ].mi_type;
185 make_singlevalued_berval( mi[ i ].mi_val, mi[ i ].mi_len );
190 if ( ldmarr != NULL ) {
191 ldmarr[ nattrs ] = NULL;
193 /* Perform the operation */
194 Debug( LDAP_DEBUG_ARGS, "replica %s:%d - add dn \"%s\"\n",
195 ri->ri_hostname, ri->ri_port, re->re_dn );
196 rc = ldap_add_s( ri->ri_ldp, re->re_dn, ldmarr );
198 ldap_get_option( ri->ri_ldp, LDAP_OPT_ERROR_NUMBER, &lderr);
201 *errmsg = "No modifications to do";
202 Debug( LDAP_DEBUG_ANY,
203 "Error: op_ldap_add: no mods to do (%s)!", re->re_dn, 0, 0 );
205 free_ldmarr( ldmarr );
213 * Perform an ldap modify operation.
215 #define AWAITING_OP -1
224 int state; /* This code is a simple-minded state machine */
225 int nvals; /* Number of values we're modifying */
226 int nops; /* Number of LDAPMod structs in ldmarr */
227 LDAPMod *ldm, *nldm, **ldmarr;
237 if ( re->re_mods == NULL ) {
238 *errmsg = "No arguments given";
239 Debug( LDAP_DEBUG_ANY, "Error: op_ldap_modify: no arguments\n",
245 * Construct a null-terminated array of LDAPMod structs.
247 for ( mi = re->re_mods, i = 0; mi[ i ].mi_type != NULL; i++ ) {
248 type = mi[ i ].mi_type;
249 value = mi[ i ].mi_val;
250 len = mi[ i ].mi_len;
251 switch ( getmodtype( type )) {
253 state = T_MODSEP; /* Got a separator line "-\n" */
257 ldmarr = ( LDAPMod ** )
258 ch_realloc(ldmarr, (( nops + 2 ) * ( sizeof( LDAPMod * ))));
259 ldmarr[ nops ] = ldm = alloc_ldapmod();
260 ldm->mod_op = LDAP_MOD_ADD | LDAP_MOD_BVALUES;
261 ldm->mod_type = value;
266 state = T_MODOPREPLACE;
267 ldmarr = ( LDAPMod ** )
268 ch_realloc(ldmarr, (( nops + 2 ) * ( sizeof( LDAPMod * ))));
269 ldmarr[ nops ] = ldm = alloc_ldapmod();
270 ldm->mod_op = LDAP_MOD_REPLACE | LDAP_MOD_BVALUES;
271 ldm->mod_type = value;
276 state = T_MODOPDELETE;
277 ldmarr = ( LDAPMod ** )
278 ch_realloc(ldmarr, (( nops + 2 ) * ( sizeof( LDAPMod * ))));
279 ldmarr[ nops ] = ldm = alloc_ldapmod();
280 ldm->mod_op = LDAP_MOD_DELETE | LDAP_MOD_BVALUES;
281 ldm->mod_type = value;
286 if ( state == AWAITING_OP ) {
287 Debug( LDAP_DEBUG_ANY,
288 "Error: op_ldap_modify: unknown mod type \"%s\"\n",
294 * We should have an attribute: value pair here.
295 * Construct the mod_bvalues part of the ldapmod struct.
297 if ( strcasecmp( type, ldm->mod_type )) {
298 Debug( LDAP_DEBUG_ANY,
299 "Error: malformed modify op, %s: %s (expecting %s:)\n",
300 type, value, ldm->mod_type );
303 ldm->mod_bvalues = ( struct berval ** )
304 ch_realloc( ldm->mod_bvalues,
305 ( nvals + 2 ) * sizeof( struct berval * ));
306 ldm->mod_bvalues[ nvals + 1 ] = NULL;
307 ldm->mod_bvalues[ nvals ] = ( struct berval * )
308 ch_malloc( sizeof( struct berval ));
309 ldm->mod_bvalues[ nvals ]->bv_val = value;
310 ldm->mod_bvalues[ nvals ]->bv_len = len;
314 ldmarr[ nops ] = NULL;
317 /* Actually perform the LDAP operation */
318 Debug( LDAP_DEBUG_ARGS, "replica %s:%d - modify dn \"%s\"\n",
319 ri->ri_hostname, ri->ri_port, re->re_dn );
320 rc = ldap_modify_s( ri->ri_ldp, re->re_dn, ldmarr );
322 free_ldmarr( ldmarr );
330 * Perform an ldap delete operation.
341 Debug( LDAP_DEBUG_ARGS, "replica %s:%d - delete dn \"%s\"\n",
342 ri->ri_hostname, ri->ri_port, re->re_dn );
343 rc = ldap_delete_s( ri->ri_ldp, re->re_dn );
352 * Perform an ldap modrdn operation.
355 #define GOT_DRDNFLAGSTR 2
356 #define GOT_ALLNEWRDNFLAGS ( GOT_NEWRDN | GOT_DRDNFLAGSTR )
372 if ( re->re_mods == NULL ) {
373 *errmsg = "No arguments given";
374 Debug( LDAP_DEBUG_ANY, "Error: op_ldap_modrdn: no arguments\n",
380 * Get the arguments: should see newrdn: and deleteoldrdn: args.
382 for ( mi = re->re_mods, i = 0; mi[ i ].mi_type != NULL; i++ ) {
383 if ( !strcmp( mi[ i ].mi_type, T_NEWRDNSTR )) {
384 newrdn = mi[ i ].mi_val;
386 } else if ( !strcmp( mi[ i ].mi_type, T_DRDNFLAGSTR )) {
387 state |= GOT_DRDNFLAGSTR;
388 if ( !strcmp( mi[ i ].mi_val, "0" )) {
390 } else if ( !strcmp( mi[ i ].mi_val, "1" )) {
393 Debug( LDAP_DEBUG_ANY,
394 "Error: op_ldap_modrdn: bad deleteoldrdn arg \"%s\"\n",
395 mi[ i ].mi_val, 0, 0 );
396 *errmsg = "Incorrect argument to deleteoldrdn";
400 Debug( LDAP_DEBUG_ANY, "Error: op_ldap_modrdn: bad type \"%s\"\n",
401 mi[ i ].mi_type, 0, 0 );
402 *errmsg = "Bad value in replication log entry";
408 * Punt if we don't have all the args.
410 if ( state != GOT_ALLNEWRDNFLAGS ) {
411 Debug( LDAP_DEBUG_ANY, "Error: op_ldap_modrdn: missing arguments\n",
413 *errmsg = "Missing argument: requires \"newrdn\" and \"deleteoldrdn\"";
418 if ( ldap_debug & LDAP_DEBUG_ARGS ) {
421 sprintf( buf, "%s:%d", ri->ri_hostname, ri->ri_port );
422 buf2 = (char *) ch_malloc( strlen( re->re_dn ) + strlen( mi->mi_val )
424 sprintf( buf2, "(\"%s\" -> \"%s\")", re->re_dn, mi->mi_val );
425 Debug( LDAP_DEBUG_ARGS,
426 "replica %s - modify rdn %s (flag: %d)\n",
427 buf, buf2, drdnflag );
430 #endif /* LDAP_DEBUG */
433 rc = ldap_modrdn2_s( ri->ri_ldp, re->re_dn, mi->mi_val, drdnflag );
435 ldap_get_option( ri->ri_ldp, LDAP_OPT_ERROR_NUMBER, &lderr);
442 * Allocate and initialize an ldapmod struct.
449 ldm = ( struct ldapmod * ) ch_malloc( sizeof ( struct ldapmod ));
450 ldm->mod_type = NULL;
451 ldm->mod_bvalues = ( struct berval ** ) NULL;
458 * Free an ldapmod struct associated mod_bvalues. NOTE - it is assumed
459 * that mod_bvalues and mod_type contain pointers to the same block of memory
460 * pointed to by the repl struct. Therefore, it's not freed here.
471 if ( ldm->mod_bvalues != NULL ) {
472 for ( i = 0; ldm->mod_bvalues[ i ] != NULL; i++ ) {
473 free( ldm->mod_bvalues[ i ] );
475 free( ldm->mod_bvalues );
483 * Free an an array of LDAPMod pointers and the LDAPMod structs they point
492 for ( i = 0; ldmarr[ i ] != NULL; i++ ) {
493 free_ldapmod( ldmarr[ i ] );
500 * Create a berval with a single value.
502 static struct berval **
503 make_singlevalued_berval(
509 p = ( struct berval ** ) ch_malloc( 2 * sizeof( struct berval * ));
510 p[ 0 ] = ( struct berval * ) ch_malloc( sizeof( struct berval ));
512 p[ 0 ]->bv_val = value;
513 p[ 0 ]->bv_len = len;
519 * Given a modification type (string), return an enumerated type.
520 * Avoids ugly copy in op_ldap_modify - lets us use a switch statement
527 if ( !strcmp( type, T_MODSEPSTR )) {
530 if ( !strcmp( type, T_MODOPADDSTR )) {
531 return( T_MODOPADD );
533 if ( !strcmp( type, T_MODOPREPLACESTR )) {
534 return( T_MODOPREPLACE );
536 if ( !strcmp( type, T_MODOPDELETESTR )) {
537 return( T_MODOPDELETE );
544 * Perform an LDAP unbind operation. If replica is NULL, or the
545 * repl_ldp is NULL, just return LDAP_SUCCESS. Otherwise, unbind,
546 * set the ldp to NULL, and return the result of the unbind call.
553 int rc = LDAP_SUCCESS;
555 if (( ri != NULL ) && ( ri->ri_ldp != NULL )) {
556 rc = ldap_unbind( ri->ri_ldp );
557 if ( rc != LDAP_SUCCESS ) {
558 Debug( LDAP_DEBUG_ANY,
559 "Error: do_unbind: ldap_unbind failed for %s:%d: %s\n",
560 ldap_err2string( rc ), ri->ri_hostname, ri->ri_port );
570 * Perform an LDAP bind operation to the replication site given
571 * by replica. If replica->repl_ldp is non-NULL, then we unbind
572 * from the replica before rebinding. It should be safe to call
573 * this to re-connect if the replica's connection goes away
576 * Returns 0 on success, -1 if an LDAP error occurred, and a return
577 * code > 0 if some other error occurred, e.g. invalid bind method.
578 * If an LDAP error occurs, the LDAP error is returned in lderr.
593 char *skrbnames[ 2 ];
594 char realm[ REALM_SZ ];
595 char name[ ANAME_SZ ];
596 char instance[ INST_SZ ];
597 #endif /* HAVE_KERBEROS */
602 Debug( LDAP_DEBUG_ANY, "Error: do_bind: null ri ptr\n", 0, 0, 0 );
603 return( BIND_ERR_BADRI );
606 if ( ri->ri_ldp != NULL ) {
607 ldrc = ldap_unbind( ri->ri_ldp );
608 if ( ldrc != LDAP_SUCCESS ) {
609 Debug( LDAP_DEBUG_ANY,
610 "Error: do_bind: ldap_unbind failed: %s\n",
611 ldap_err2string( ldrc ), 0, 0 );
616 Debug( LDAP_DEBUG_ARGS, "Open connection to %s:%d\n",
617 ri->ri_hostname, ri->ri_port, 0 );
618 ri->ri_ldp = ldap_open( ri->ri_hostname, ri->ri_port );
619 if ( ri->ri_ldp == NULL ) {
620 Debug( LDAP_DEBUG_ANY, "Error: ldap_open(%s, %d) failed: %s\n",
621 ri->ri_hostname, ri->ri_port, sys_errlist[ errno ] );
622 return( BIND_ERR_OPEN );
626 * Set ldap library options to (1) not follow referrals, and
627 * (2) restart the select() system call.
629 ldap_set_option(ri->ri_ldp, LDAP_OPT_REFERRALS, LDAP_OPT_OFF);
630 ldap_set_option(ri->ri_ldp, LDAP_OPT_RESTART, LDAP_OPT_ON);
632 switch ( ri->ri_bind_method ) {
634 #ifndef HAVE_KERBEROS
635 Debug( LDAP_DEBUG_ANY,
636 "Error: Kerberos bind for %s:%d, but not compiled w/kerberos\n",
637 ri->ri_hostname, ri->ri_port, 0 );
638 return( BIND_ERR_KERBEROS_FAILED );
639 #else /* HAVE_KERBEROS */
641 * Bind using kerberos.
642 * If "bindprincipal" was given in the config file, then attempt
643 * to get a TGT for that principal (via the srvtab file). If only
644 * a binddn was given, then we need to read that entry to get
645 * the kerberosName attributes, and try to get a TGT for one
646 * of them. All are tried. The first one which succeeds is
647 * returned. XXX It might be a good idea to just require a
648 * bindprincipal. Reading the entry every time might be a significant
649 * amount of overhead, if the connection is closed between most
653 if ( ri->ri_principal != NULL ) {
654 skrbnames[ 0 ] = ri->ri_principal;
655 skrbnames[ 1 ] = NULL;
656 krbnames = skrbnames;
658 krbnames = read_krbnames( ri );
661 if (( krbnames == NULL ) || ( krbnames[ 0 ] == NULL )) {
662 Debug( LDAP_DEBUG_ANY,
663 "Error: Can't find krbname for binddn \"%s\"\n",
664 ri->ri_bind_dn, 0, 0 );
665 retval = BIND_ERR_KERBEROS_FAILED;
669 * Now we've got one or more kerberos principals. See if any
670 * of them are in the srvtab file.
673 for ( kni = 0; krbnames[ kni ] != NULL; kni++ ) {
674 rc = kname_parse( name, instance, realm, krbnames[ kni ]);
675 if ( rc != KSUCCESS ) {
679 rc = krb_get_svc_in_tkt( name, instance, realm, "krbtgt", realm,
681 if ( rc != KSUCCESS) {
682 Debug( LDAP_DEBUG_ANY, "Error: Can't get TGT for %s: %s\n",
683 krbnames[ kni ], krb_err_txt[ rc ], 0 );
690 Debug( LDAP_DEBUG_ANY,
691 "Error: Could not obtain TGT for DN \"%s\"\n",
692 ri->ri_bind_dn, 0, 0 );
693 retval = BIND_ERR_KERBEROS_FAILED;
697 * We've got a TGT. Do a kerberos bind.
699 Debug( LDAP_DEBUG_ARGS, "bind to %s:%d as %s (kerberos)\n",
700 ri->ri_hostname, ri->ri_port, ri->ri_bind_dn );
701 ldrc = ldap_kerberos_bind_s( ri->ri_ldp, ri->ri_bind_dn );
702 ri->ri_principal = strdup( krbnames[ kni ] );
703 if ( ldrc != LDAP_SUCCESS ) {
704 Debug( LDAP_DEBUG_ANY, "Error: kerberos bind for %s:%dfailed: %s\n",
705 ri->ri_hostname, ri->ri_port, ldap_err2string( ldrc ));
707 retval = BIND_ERR_KERBEROS_FAILED;
710 kexit: if ( krbnames != NULL ) {
711 ldap_value_free( krbnames );
715 #endif /* HAVE_KERBEROS */
718 * Bind with a plaintext password.
720 Debug( LDAP_DEBUG_ARGS, "bind to %s:%d as %s (simple)\n",
721 ri->ri_hostname, ri->ri_port, ri->ri_bind_dn );
722 ldrc = ldap_simple_bind_s( ri->ri_ldp, ri->ri_bind_dn,
724 if ( ldrc != LDAP_SUCCESS ) {
725 Debug( LDAP_DEBUG_ANY,
726 "Error: ldap_simple_bind_s for %s:%d failed: %s\n",
727 ri->ri_hostname, ri->ri_port, ldap_err2string( ldrc ));
729 return( BIND_ERR_SIMPLE_FAILED );
735 Debug( LDAP_DEBUG_ANY,
736 "Error: do_bind: unknown auth type \"%d\" for %s:%d\n",
737 ri->ri_bind_method, ri->ri_hostname, ri->ri_port );
738 return( BIND_ERR_BAD_ATYPE );
747 * For debugging. Print the contents of an ldmarr array.
758 for ( i = 0; ldmarr[ i ] != NULL; i++ ) {
760 Debug( LDAP_DEBUG_TRACE,
761 "Trace (%d): *** ldmarr[ %d ] contents:\n",
763 Debug( LDAP_DEBUG_TRACE,
764 "Trace (%d): *** ldm->mod_op: %d\n",
765 getpid(), ldm->mod_op, 0 );
766 Debug( LDAP_DEBUG_TRACE,
767 "Trace (%d): *** ldm->mod_type: %s\n",
768 getpid(), ldm->mod_type, 0 );
769 if ( ldm->mod_bvalues != NULL ) {
770 for ( j = 0; ( b = ldm->mod_bvalues[ j ] ) != NULL; j++ ) {
771 msgbuf = ch_malloc( b->bv_len + 512 );
772 sprintf( msgbuf, "***** bv[ %d ] len = %d, val = <%s>",
773 j, b->bv_len, b->bv_val );
774 Debug( LDAP_DEBUG_TRACE,
775 "Trace (%d):%s\n", getpid(), msgbuf, 0 );
784 * Get the kerberos names from the binddn for "replica" via an ldap search.
785 * Returns a null-terminated array of char *, or NULL if the entry could
786 * not be found or there were no kerberosName attributes. The caller is
787 * responsible for freeing the returned array and strings it points to.
797 LDAPMessage *result, *entry;
799 /* First need to bind as NULL */
800 rc = ldap_simple_bind_s( ri->ri_ldp, NULL, NULL );
801 if ( rc != LDAP_SUCCESS ) {
802 Debug( LDAP_DEBUG_ANY,
803 "Error: null bind failed getting krbnames for %s:%d: %s\n",
804 ri->ri_hostname, ri->ri_port, ldap_err2string( rc ));
807 rc = ldap_search_st( ri->ri_ldp, ri->ri_bind_dn, LDAP_SCOPE_BASE,
808 "objectclass=*", kattrs, 0, &kst, &result );
809 if ( rc != LDAP_SUCCESS ) {
810 Debug( LDAP_DEBUG_ANY,
811 "Error: search failed getting krbnames for %s:%d: %s\n",
812 ri->ri_hostname, ri->ri_port, ldap_err2string( rc ));
815 ne = ldap_count_entries( ri->ri_ldp, result );
817 Debug( LDAP_DEBUG_ANY,
818 "Error: Can't find entry \"%s\" for %s:%d kerberos bind\n",
819 ri->ri_bind_dn, ri->ri_hostname, ri->ri_port );
823 Debug( LDAP_DEBUG_ANY,
824 "Error: Kerberos binddn \"%s\" for %s:%dis ambiguous\n",
825 ri->ri_bind_dn, ri->ri_hostname, ri->ri_port );
828 entry = ldap_first_entry( ri->ri_ldp, result );
829 if ( entry == NULL ) {
830 Debug( LDAP_DEBUG_ANY,
831 "Error: Can't find \"%s\" for kerberos binddn for %s:%d\n",
832 ri->ri_bind_dn, ri->ri_hostname, ri->ri_port );
835 krbnames = ldap_get_values( ri->ri_ldp, entry, "kerberosName" );
836 ldap_msgfree( result );
851 for ( p = s; ( p != NULL ) && ( *p != '\0' ); p++ ) {
852 if ( islower( *p )) {