1 /* ldapmodify.c - generic program to modify or add entries using LDAP */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2010 The OpenLDAP Foundation.
6 * Portions Copyright 2006 Howard Chu.
7 * Portions Copyright 1998-2003 Kurt D. Zeilenga.
8 * Portions Copyright 1998-2001 Net Boolean Incorporated.
9 * Portions Copyright 2001-2003 IBM Corporation.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted only as authorized by the OpenLDAP
16 * A copy of this license is available in the file LICENSE in the
17 * top-level directory of the distribution or, alternatively, at
18 * <http://www.OpenLDAP.org/license.html>.
20 /* Portions Copyright (c) 1992-1996 Regents of the University of Michigan.
21 * All rights reserved.
23 * Redistribution and use in source and binary forms are permitted
24 * provided that this notice is preserved and that due credit is given
25 * to the University of Michigan at Ann Arbor. The name of the
26 * University may not be used to endorse or promote products derived
27 * from this software without specific prior written permission. This
28 * software is provided ``as is'' without express or implied warranty.
31 * This work was originally developed by the University of Michigan
32 * (as part of U-MICH LDAP). Additional significant contributors
43 #include <ac/stdlib.h>
45 #include <ac/string.h>
46 #include <ac/unistd.h>
47 #include <ac/socket.h>
50 #ifdef HAVE_SYS_STAT_H
54 #ifdef HAVE_SYS_FILE_H
64 #include "lutil_ldap.h"
66 #include "ldap_defaults.h"
74 static char *rejfile = NULL;
75 static LDAP *ld = NULL;
77 static int process_ldif_rec LDAP_P(( char *rbuf, int lineno ));
78 static int domodify LDAP_P((
79 const struct berval *dn,
83 static int dodelete LDAP_P((
84 const struct berval *dn,
85 LDAPControl **pctrls ));
86 static int dorename LDAP_P((
87 const struct berval *dn,
88 const struct berval *newrdn,
89 const struct berval *newsup,
91 LDAPControl **pctrls ));
92 static int process_response(
96 const struct berval *dn );
100 static int txnabort = 0;
101 struct berval *txn_id = NULL;
107 fprintf( stderr, _("Add or modify entries from an LDAP server\n\n"));
108 fprintf( stderr, _("usage: %s [options]\n"), prog);
109 fprintf( stderr, _(" The list of desired operations are read from stdin"
110 " or from the file\n"));
111 fprintf( stderr, _(" specified by \"-f file\".\n"));
112 fprintf( stderr, _("Add or modify options:\n"));
113 fprintf( stderr, _(" -a add values (%s)\n"),
114 (ldapadd ? _("default") : _("default is to replace")));
115 fprintf( stderr, _(" -c continuous operation mode (do not stop on errors)\n"));
116 fprintf( stderr, _(" -E [!]ext=extparam modify extensions"
117 " (! indicate s criticality)\n"));
118 fprintf( stderr, _(" -f file read operations from `file'\n"));
119 fprintf( stderr, _(" -M enable Manage DSA IT control (-MM to make critical)\n"));
120 fprintf( stderr, _(" -P version protocol version (default: 3)\n"));
123 _(" [!]txn=<commit|abort> (transaction)\n"));
125 fprintf( stderr, _(" -S file write skipped modifications to `file'\n"));
128 exit( EXIT_FAILURE );
132 const char options[] = "aE:rS:"
133 "cd:D:e:f:h:H:IMnNO:o:p:P:QR:U:vVw:WxX:y:Y:Z";
136 handle_private_option( int i )
138 char *control, *cvalue;
142 case 'E': /* modify extensions */
143 if( protocol == LDAP_VERSION2 ) {
144 fprintf( stderr, _("%s: -E incompatible with LDAPv%d\n"),
146 exit( EXIT_FAILURE );
149 /* should be extended to support comma separated list of
150 * [!]key[=value] parameters, e.g. -E !foo,bar=567
155 if( optarg[0] == '!' ) {
160 control = ber_strdup( optarg );
161 if ( (cvalue = strchr( control, '=' )) != NULL ) {
166 if( strcasecmp( control, "txn" ) == 0 ) {
170 _("txn control previously specified\n"));
171 exit( EXIT_FAILURE );
173 if( cvalue != NULL ) {
174 if( strcasecmp( cvalue, "abort" ) == 0 ) {
176 } else if( strcasecmp( cvalue, "commit" ) != 0 ) {
177 fprintf( stderr, _("Invalid value for txn control, %s\n"),
179 exit( EXIT_FAILURE );
187 fprintf( stderr, _("Invalid modify extension name: %s\n"),
197 case 'r': /* replace (obsolete) */
200 case 'S': /* skipped modifications to file */
201 if( rejfile != NULL ) {
202 fprintf( stderr, _("%s: -S previously specified\n"), prog );
203 exit( EXIT_FAILURE );
205 rejfile = ber_strdup( optarg );
216 main( int argc, char **argv )
218 char *rbuf = NULL, *rejbuf = NULL;
220 struct LDIFFP *ldiffp, ldifdummy = {0};
221 char *matched_msg, *error_msg;
222 int rc, retval, ldifrc;
225 int lineno, nextline = 0, lmax = 0;
228 prog = lutil_progname( "ldapmodify", argc, argv );
230 /* strncmp instead of strcmp since NT binaries carry .exe extension */
231 ldapadd = ( strncasecmp( prog, "ldapadd", sizeof("ldapadd")-1 ) == 0 );
233 tool_init( ldapadd ? TOOL_ADD : TOOL_MODIFY );
235 tool_args( argc, argv );
237 if ( argc != optind ) usage();
239 if ( rejfile != NULL ) {
240 if (( rejfp = fopen( rejfile, "w" )) == NULL ) {
242 retval = EXIT_FAILURE;
249 if ( infile != NULL ) {
250 if (( ldiffp = ldif_open( infile, "r" )) == NULL ) {
252 retval = EXIT_FAILURE;
256 ldifdummy.fp = stdin;
260 if ( debug ) ldif_debug = debug;
262 ld = tool_conn_setup( dont, 0 );
270 /* start transaction */
271 rc = ldap_txn_start_s( ld, NULL, NULL, &txn_id );
272 if( rc != LDAP_SUCCESS ) {
273 tool_perror( "ldap_txn_start_s", rc, NULL, NULL, NULL, NULL );
275 retval = EXIT_FAILURE;
291 c[i].ldctl_oid = LDAP_CONTROL_X_TXN_SPEC;
292 c[i].ldctl_value = *txn_id;
293 c[i].ldctl_iscritical = 1;
299 tool_server_controls( ld, c, i );
304 while (( rc == 0 || contoper ) && ( ldifrc = ldif_read_record( ldiffp, &nextline,
305 &rbuf, &lmax )) > 0 )
308 len = strlen( rbuf );
309 if (( rejbuf = (char *)ber_memalloc( len+1 )) == NULL ) {
311 retval = EXIT_FAILURE;
314 memcpy( rejbuf, rbuf, len+1 );
317 rc = process_ldif_rec( rbuf, lineno );
320 if ( rc ) retval = rc;
322 fprintf(rejfp, _("# Error: %s (%d)"), ldap_err2string(rc), rc);
325 ldap_get_option(ld, LDAP_OPT_MATCHED_DN, &matched_msg);
326 if ( matched_msg != NULL ) {
327 if ( *matched_msg != '\0' ) {
328 fprintf( rejfp, _(", matched DN: %s"), matched_msg );
330 ldap_memfree( matched_msg );
334 ldap_get_option(ld, LDAP_OPT_DIAGNOSTIC_MESSAGE, &error_msg);
335 if ( error_msg != NULL ) {
336 if ( *error_msg != '\0' ) {
337 fprintf( rejfp, _(", additional info: %s"), error_msg );
339 ldap_memfree( error_msg );
341 fprintf( rejfp, "\n%s\n", rejbuf );
344 if (rejfp) ber_memfree( rejbuf );
352 if( retval == 0 && txn ) {
353 rc = ldap_set_option( ld, LDAP_OPT_SERVER_CONTROLS, NULL );
354 if ( rc != LDAP_OPT_SUCCESS ) {
355 fprintf( stderr, "Could not unset controls for ldap_txn_end\n");
358 /* create transaction */
359 rc = ldap_txn_end_s( ld, !txnabort, txn_id, NULL, NULL, NULL );
360 if( rc != LDAP_SUCCESS ) {
361 tool_perror( "ldap_txn_end_s", rc, NULL, NULL, NULL, NULL );
367 if ( !dont && ld != NULL ) {
374 if ( rejfp != NULL ) {
378 if ( ldiffp != NULL && ldiffp != &ldifdummy ) {
379 ldif_close( ldiffp );
387 process_ldif_rec( char *rbuf, int linenum )
390 int lrflags = ldapadd ? LDIF_DEFAULT_ADD : 0;
392 struct berval rbuf_bv;
395 if ( getenv( "LDIF_ENTRIES_ONLY" ) ) {
396 lrflags |= LDIF_ENTRIES_ONLY;
398 if ( getenv( "LDIF_NO_CONTROLS" ) ) {
399 lrflags |= LDIF_NO_CONTROLS;
401 #endif /* TEST_LDIF_API */
403 rbuf_bv.bv_val = rbuf;
404 rbuf_bv.bv_len = 0; /* not used */
405 rc = ldap_parse_ldif_record( &rbuf_bv, linenum, &lr, prog, lrflags );
407 /* If default controls are set (as with -M option) and controls are
408 specified in the LDIF file, we must add the default controls to
409 the list of controls sent with the ldap operation.
413 LDAPControl **defctrls = NULL; /* Default server controls */
414 LDAPControl **newctrls = NULL;
415 ldap_get_option(ld, LDAP_OPT_SERVER_CONTROLS, &defctrls);
417 int npc=0; /* Num of LDIF controls */
418 int ndefc=0; /* Num of default controls */
419 while (lr.lr_ctrls[npc]) npc++; /* Count LDIF controls */
420 while (defctrls[ndefc]) ndefc++; /* Count default controls */
421 newctrls = ber_memrealloc(lr.lr_ctrls,
422 (npc+ndefc+1)*sizeof(LDAPControl*));
424 if (newctrls == NULL) {
428 lr.lr_ctrls = newctrls;
429 for (i=npc; i<npc+ndefc; i++) {
430 lr.lr_ctrls[i] = ldap_control_dup(defctrls[i-npc]);
431 if (lr.lr_ctrls[i] == NULL) {
436 lr.lr_ctrls[npc+ndefc] = NULL;
438 ldap_controls_free(defctrls); /* Must be freed by library */
444 if ( LDAP_REQ_DELETE == lr.lr_op ) {
445 rc = dodelete( &lr.lr_dn, lr.lr_ctrls );
446 } else if ( LDAP_REQ_RENAME == lr.lr_op ) {
447 rc = dorename( &lr.lr_dn, &lr.lrop_newrdn, &lr.lrop_newsup, lr.lrop_delold, lr.lr_ctrls );
448 } else if ( ( LDAP_REQ_ADD == lr.lr_op ) || ( LDAP_REQ_MODIFY == lr.lr_op ) ) {
449 rc = domodify( &lr.lr_dn, lr.lrop_mods, lr.lr_ctrls, LDAP_REQ_ADD == lr.lr_op );
451 /* record skipped e.g. version: or comment or something we don't handle yet */
454 if ( rc == LDAP_SUCCESS ) {
459 ldap_ldif_record_done( &lr );
467 const struct berval *dn,
469 LDAPControl **pctrls,
472 int rc, i, j, k, notascii, op;
475 if ( ( dn == NULL ) || ( dn->bv_val == NULL ) ) {
476 fprintf( stderr, _("%s: no DN specified\n"), prog );
477 return( LDAP_PARAM_ERROR );
480 if ( pmods == NULL ) {
481 /* implement "touch" (empty sequence)
482 * modify operation (note that there
483 * is no symmetry with the UNIX command,
484 * since \"touch\" on a non-existent entry
486 printf( "warning: no attributes to %sadd (entry=\"%s\")\n",
487 newentry ? "" : "change or ", dn->bv_val );
490 for ( i = 0; pmods[ i ] != NULL; ++i ) {
491 op = pmods[ i ]->mod_op & ~LDAP_MOD_BVALUES;
492 if( op == LDAP_MOD_ADD && ( pmods[i]->mod_bvalues == NULL )) {
494 _("%s: attribute \"%s\" has no values (entry=\"%s\")\n"),
495 prog, pmods[i]->mod_type, dn->bv_val );
496 return LDAP_PARAM_ERROR;
501 for ( i = 0; pmods[ i ] != NULL; ++i ) {
502 op = pmods[ i ]->mod_op & ~LDAP_MOD_BVALUES;
504 op == LDAP_MOD_REPLACE ? _("replace") :
505 op == LDAP_MOD_ADD ? _("add") :
506 op == LDAP_MOD_INCREMENT ? _("increment") :
507 op == LDAP_MOD_DELETE ? _("delete") :
509 pmods[ i ]->mod_type );
511 if ( pmods[ i ]->mod_bvalues != NULL ) {
512 for ( j = 0; pmods[ i ]->mod_bvalues[ j ] != NULL; ++j ) {
513 bvp = pmods[ i ]->mod_bvalues[ j ];
515 for ( k = 0; (unsigned long) k < bvp->bv_len; ++k ) {
516 if ( !isascii( bvp->bv_val[ k ] )) {
522 printf( _("\tNOT ASCII (%ld bytes)\n"), bvp->bv_len );
524 printf( "\t%s\n", bvp->bv_val );
533 printf( "%sadding new entry \"%s\"\n", dont ? "!" : "", dn->bv_val );
535 printf( "%smodifying entry \"%s\"\n", dont ? "!" : "", dn->bv_val );
541 rc = ldap_add_ext( ld, dn->bv_val, pmods, pctrls, NULL, &msgid );
543 rc = ldap_modify_ext( ld, dn->bv_val, pmods, pctrls, NULL, &msgid );
546 if ( rc != LDAP_SUCCESS ) {
547 /* print error message about failed update including DN */
548 fprintf( stderr, _("%s: update failed: %s\n"), prog, dn->bv_val );
549 tool_perror( newentry ? "ldap_add" : "ldap_modify",
550 rc, NULL, NULL, NULL, NULL );
553 rc = process_response( ld, msgid,
554 newentry ? LDAP_RES_ADD : LDAP_RES_MODIFY, dn );
556 if ( verbose && rc == LDAP_SUCCESS ) {
557 printf( _("modify complete\n") );
572 const struct berval *dn,
573 LDAPControl **pctrls )
578 assert( dn != NULL );
579 assert( dn->bv_val != NULL );
580 printf( _("%sdeleting entry \"%s\"\n"), dont ? "!" : "", dn->bv_val );
582 rc = ldap_delete_ext( ld, dn->bv_val, pctrls, NULL, &msgid );
583 if ( rc != LDAP_SUCCESS ) {
584 fprintf( stderr, _("%s: delete failed: %s\n"), prog, dn->bv_val );
585 tool_perror( "ldap_delete", rc, NULL, NULL, NULL, NULL );
588 rc = process_response( ld, msgid, LDAP_RES_DELETE, dn );
590 if ( verbose && rc == LDAP_SUCCESS ) {
591 printf( _("delete complete\n") );
605 const struct berval *dn,
606 const struct berval *newrdn,
607 const struct berval *newsup,
609 LDAPControl **pctrls )
614 assert( dn != NULL );
615 assert( dn->bv_val != NULL );
616 assert( newrdn != NULL );
617 assert( newrdn->bv_val != NULL );
618 printf( _("%smodifying rdn of entry \"%s\"\n"), dont ? "!" : "", dn->bv_val );
620 printf( _("\tnew RDN: \"%s\" (%skeep existing values)\n"),
621 newrdn->bv_val, deleteoldrdn ? _("do not ") : "" );
624 rc = ldap_rename( ld, dn->bv_val, newrdn->bv_val,
625 ( newsup && newsup->bv_val ) ? newsup->bv_val : NULL,
626 deleteoldrdn, pctrls, NULL, &msgid );
627 if ( rc != LDAP_SUCCESS ) {
628 fprintf( stderr, _("%s: rename failed: %s\n"), prog, dn->bv_val );
629 tool_perror( "ldap_rename", rc, NULL, NULL, NULL, NULL );
632 rc = process_response( ld, msgid, LDAP_RES_RENAME, dn );
634 if ( verbose && rc == LDAP_SUCCESS ) {
635 printf( _("rename complete\n") );
651 case LDAP_RES_DELETE:
652 return "ldap_delete";
653 case LDAP_RES_MODIFY:
654 return "ldap_modify";
655 case LDAP_RES_MODRDN:
656 return "ldap_rename";
661 return "ldap_unknown";
664 static int process_response(
668 const struct berval *dn )
671 int rc = LDAP_OTHER, msgtype;
672 struct timeval tv = { 0, 0 };
674 char *text = NULL, *matched = NULL, **refs = NULL;
675 LDAPControl **ctrls = NULL;
677 assert( dn != NULL );
682 rc = ldap_result( ld, msgid, LDAP_MSG_ALL, &tv, &res );
683 if ( tool_check_abandon( ld, msgid ) ) {
684 return LDAP_CANCELLED;
688 ldap_get_option( ld, LDAP_OPT_RESULT_CODE, &rc );
689 tool_perror( "ldap_result", rc, NULL, NULL, NULL, NULL );
698 msgtype = ldap_msgtype( res );
700 rc = ldap_parse_result( ld, res, &err, &matched, &text, &refs, &ctrls, 1 );
701 if ( rc == LDAP_SUCCESS ) rc = err;
704 if ( rc == LDAP_X_TXN_SPECIFY_OKAY ) {
708 if ( rc != LDAP_SUCCESS ) {
709 tool_perror( res2str( op ), rc, NULL, matched, text, refs );
710 } else if ( msgtype != op ) {
711 fprintf( stderr, "%s: msgtype: expected %d got %d\n",
712 res2str( op ), op, msgtype );
716 if ( text ) ldap_memfree( text );
717 if ( matched ) ldap_memfree( matched );
718 if ( text ) ber_memvfree( (void **)refs );
721 tool_print_ctrls( ld, ctrls );
722 ldap_controls_free( ctrls );