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"
73 static char *rejfile = NULL;
74 static LDAP *ld = NULL;
76 static int process_ldif_rec LDAP_P(( char *rbuf, int lineno ));
77 static int domodify LDAP_P((
78 const struct berval *dn,
82 static int dodelete LDAP_P((
83 const struct berval *dn,
84 LDAPControl **pctrls ));
85 static int dorename LDAP_P((
86 const struct berval *dn,
87 const struct berval *newrdn,
88 const struct berval *newsup,
90 LDAPControl **pctrls ));
91 static int process_response(
95 const struct berval *dn );
99 static int txnabort = 0;
100 struct berval *txn_id = NULL;
106 fprintf( stderr, _("Add or modify entries from an LDAP server\n\n"));
107 fprintf( stderr, _("usage: %s [options]\n"), prog);
108 fprintf( stderr, _(" The list of desired operations are read from stdin"
109 " or from the file\n"));
110 fprintf( stderr, _(" specified by \"-f file\".\n"));
111 fprintf( stderr, _("Add or modify options:\n"));
112 fprintf( stderr, _(" -a add values (%s)\n"),
113 (ldapadd ? _("default") : _("default is to replace")));
114 fprintf( stderr, _(" -c continuous operation mode (do not stop on errors)\n"));
115 fprintf( stderr, _(" -E [!]ext=extparam modify extensions"
116 " (! indicate s criticality)\n"));
117 fprintf( stderr, _(" -f file read operations from `file'\n"));
118 fprintf( stderr, _(" -M enable Manage DSA IT control (-MM to make critical)\n"));
119 fprintf( stderr, _(" -P version protocol version (default: 3)\n"));
122 _(" [!]txn=<commit|abort> (transaction)\n"));
124 fprintf( stderr, _(" -S file write skipped modifications to `file'\n"));
127 exit( EXIT_FAILURE );
131 const char options[] = "aE:rS:"
132 "cd:D:e:f:h:H:IMnNO:o:p:P:QR:U:vVw:WxX:y:Y:Z";
135 handle_private_option( int i )
137 char *control, *cvalue;
141 case 'E': /* modify extensions */
142 if( protocol == LDAP_VERSION2 ) {
143 fprintf( stderr, _("%s: -E incompatible with LDAPv%d\n"),
145 exit( EXIT_FAILURE );
148 /* should be extended to support comma separated list of
149 * [!]key[=value] parameters, e.g. -E !foo,bar=567
154 if( optarg[0] == '!' ) {
159 control = ber_strdup( optarg );
160 if ( (cvalue = strchr( control, '=' )) != NULL ) {
165 if( strcasecmp( control, "txn" ) == 0 ) {
169 _("txn control previously specified\n"));
170 exit( EXIT_FAILURE );
172 if( cvalue != NULL ) {
173 if( strcasecmp( cvalue, "abort" ) == 0 ) {
175 } else if( strcasecmp( cvalue, "commit" ) != 0 ) {
176 fprintf( stderr, _("Invalid value for txn control, %s\n"),
178 exit( EXIT_FAILURE );
186 fprintf( stderr, _("Invalid modify extension name: %s\n"),
196 case 'r': /* replace (obsolete) */
199 case 'S': /* skipped modifications to file */
200 if( rejfile != NULL ) {
201 fprintf( stderr, _("%s: -S previously specified\n"), prog );
202 exit( EXIT_FAILURE );
204 rejfile = ber_strdup( optarg );
215 main( int argc, char **argv )
217 char *rbuf = NULL, *rejbuf = NULL;
219 struct LDIFFP *ldiffp, ldifdummy = {0};
220 char *matched_msg, *error_msg;
221 int rc, retval, ldifrc;
224 int lineno, nextline = 0, lmax = 0;
227 prog = lutil_progname( "ldapmodify", argc, argv );
229 /* strncmp instead of strcmp since NT binaries carry .exe extension */
230 ldapadd = ( strncasecmp( prog, "ldapadd", sizeof("ldapadd")-1 ) == 0 );
232 tool_init( ldapadd ? TOOL_ADD : TOOL_MODIFY );
234 tool_args( argc, argv );
236 if ( argc != optind ) usage();
238 if ( rejfile != NULL ) {
239 if (( rejfp = fopen( rejfile, "w" )) == NULL ) {
241 retval = EXIT_FAILURE;
248 if ( infile != NULL ) {
249 if (( ldiffp = ldif_open( infile, "r" )) == NULL ) {
251 retval = EXIT_FAILURE;
255 ldifdummy.fp = stdin;
259 if ( debug ) ldif_debug = debug;
261 ld = tool_conn_setup( dont, 0 );
269 /* start transaction */
270 rc = ldap_txn_start_s( ld, NULL, NULL, &txn_id );
271 if( rc != LDAP_SUCCESS ) {
272 tool_perror( "ldap_txn_start_s", rc, NULL, NULL, NULL, NULL );
274 retval = EXIT_FAILURE;
290 c[i].ldctl_oid = LDAP_CONTROL_X_TXN_SPEC;
291 c[i].ldctl_value = *txn_id;
292 c[i].ldctl_iscritical = 1;
298 tool_server_controls( ld, c, i );
303 while (( rc == 0 || contoper ) && ( ldifrc = ldif_read_record( ldiffp, &nextline,
304 &rbuf, &lmax )) > 0 )
307 len = strlen( rbuf );
308 if (( rejbuf = (char *)ber_memalloc( len+1 )) == NULL ) {
310 retval = EXIT_FAILURE;
313 memcpy( rejbuf, rbuf, len+1 );
316 rc = process_ldif_rec( rbuf, lineno );
319 if ( rc ) retval = rc;
321 fprintf(rejfp, _("# Error: %s (%d)"), ldap_err2string(rc), rc);
324 ldap_get_option(ld, LDAP_OPT_MATCHED_DN, &matched_msg);
325 if ( matched_msg != NULL ) {
326 if ( *matched_msg != '\0' ) {
327 fprintf( rejfp, _(", matched DN: %s"), matched_msg );
329 ldap_memfree( matched_msg );
333 ldap_get_option(ld, LDAP_OPT_DIAGNOSTIC_MESSAGE, &error_msg);
334 if ( error_msg != NULL ) {
335 if ( *error_msg != '\0' ) {
336 fprintf( rejfp, _(", additional info: %s"), error_msg );
338 ldap_memfree( error_msg );
340 fprintf( rejfp, "\n%s\n", rejbuf );
343 if (rejfp) ber_memfree( rejbuf );
351 if( retval == 0 && txn ) {
352 rc = ldap_set_option( ld, LDAP_OPT_SERVER_CONTROLS, NULL );
353 if ( rc != LDAP_OPT_SUCCESS ) {
354 fprintf( stderr, "Could not unset controls for ldap_txn_end\n");
357 /* create transaction */
358 rc = ldap_txn_end_s( ld, !txnabort, txn_id, NULL, NULL, NULL );
359 if( rc != LDAP_SUCCESS ) {
360 tool_perror( "ldap_txn_end_s", rc, NULL, NULL, NULL, NULL );
366 if ( !dont && ld != NULL ) {
373 if ( rejfp != NULL ) {
377 if ( ldiffp != NULL && ldiffp != &ldifdummy ) {
378 ldif_close( ldiffp );
386 process_ldif_rec( char *rbuf, int linenum )
389 int lrflags = ldapadd ? LDIF_DEFAULT_ADD : 0;
391 struct berval rbuf_bv;
394 if ( getenv( "LDIF_ENTRIES_ONLY" ) ) {
395 lrflags |= LDIF_ENTRIES_ONLY;
397 if ( getenv( "LDIF_NO_CONTROLS" ) ) {
398 lrflags |= LDIF_NO_CONTROLS;
400 #endif /* TEST_LDIF_API */
402 rbuf_bv.bv_val = rbuf;
403 rbuf_bv.bv_len = 0; /* not used */
404 rc = ldap_parse_ldif_record( &rbuf_bv, linenum, &lr, prog, lrflags );
406 /* If default controls are set (as with -M option) and controls are
407 specified in the LDIF file, we must add the default controls to
408 the list of controls sent with the ldap operation.
412 LDAPControl **defctrls = NULL; /* Default server controls */
413 LDAPControl **newctrls = NULL;
414 ldap_get_option(ld, LDAP_OPT_SERVER_CONTROLS, &defctrls);
416 int npc=0; /* Num of LDIF controls */
417 int ndefc=0; /* Num of default controls */
418 while (lr.lr_ctrls[npc]) npc++; /* Count LDIF controls */
419 while (defctrls[ndefc]) ndefc++; /* Count default controls */
420 newctrls = ber_memrealloc(lr.lr_ctrls,
421 (npc+ndefc+1)*sizeof(LDAPControl*));
423 if (newctrls == NULL) {
427 lr.lr_ctrls = newctrls;
428 for (i=npc; i<npc+ndefc; i++) {
429 lr.lr_ctrls[i] = ldap_control_dup(defctrls[i-npc]);
430 if (lr.lr_ctrls[i] == NULL) {
435 lr.lr_ctrls[npc+ndefc] = NULL;
437 ldap_controls_free(defctrls); /* Must be freed by library */
443 if ( LDAP_REQ_DELETE == lr.lr_op ) {
444 rc = dodelete( &lr.lr_dn, lr.lr_ctrls );
445 } else if ( LDAP_REQ_RENAME == lr.lr_op ) {
446 rc = dorename( &lr.lr_dn, &lr.lrop_newrdn, &lr.lrop_newsup, lr.lrop_delold, lr.lr_ctrls );
447 } else if ( ( LDAP_REQ_ADD == lr.lr_op ) || ( LDAP_REQ_MODIFY == lr.lr_op ) ) {
448 rc = domodify( &lr.lr_dn, lr.lrop_mods, lr.lr_ctrls, LDAP_REQ_ADD == lr.lr_op );
450 /* record skipped e.g. version: or comment or something we don't handle yet */
453 if ( rc == LDAP_SUCCESS ) {
458 ldap_ldif_record_done( &lr );
466 const struct berval *dn,
468 LDAPControl **pctrls,
471 int rc, i, j, k, notascii, op;
474 if ( ( dn == NULL ) || ( dn->bv_val == NULL ) ) {
475 fprintf( stderr, _("%s: no DN specified\n"), prog );
476 return( LDAP_PARAM_ERROR );
479 if ( pmods == NULL ) {
480 /* implement "touch" (empty sequence)
481 * modify operation (note that there
482 * is no symmetry with the UNIX command,
483 * since \"touch\" on a non-existent entry
485 printf( "warning: no attributes to %sadd (entry=\"%s\")\n",
486 newentry ? "" : "change or ", dn->bv_val );
489 for ( i = 0; pmods[ i ] != NULL; ++i ) {
490 op = pmods[ i ]->mod_op & ~LDAP_MOD_BVALUES;
491 if( op == LDAP_MOD_ADD && ( pmods[i]->mod_bvalues == NULL )) {
493 _("%s: attribute \"%s\" has no values (entry=\"%s\")\n"),
494 prog, pmods[i]->mod_type, dn->bv_val );
495 return LDAP_PARAM_ERROR;
500 for ( i = 0; pmods[ i ] != NULL; ++i ) {
501 op = pmods[ i ]->mod_op & ~LDAP_MOD_BVALUES;
503 op == LDAP_MOD_REPLACE ? _("replace") :
504 op == LDAP_MOD_ADD ? _("add") :
505 op == LDAP_MOD_INCREMENT ? _("increment") :
506 op == LDAP_MOD_DELETE ? _("delete") :
508 pmods[ i ]->mod_type );
510 if ( pmods[ i ]->mod_bvalues != NULL ) {
511 for ( j = 0; pmods[ i ]->mod_bvalues[ j ] != NULL; ++j ) {
512 bvp = pmods[ i ]->mod_bvalues[ j ];
514 for ( k = 0; (unsigned long) k < bvp->bv_len; ++k ) {
515 if ( !isascii( bvp->bv_val[ k ] )) {
521 printf( _("\tNOT ASCII (%ld bytes)\n"), bvp->bv_len );
523 printf( "\t%s\n", bvp->bv_val );
532 printf( "%sadding new entry \"%s\"\n", dont ? "!" : "", dn->bv_val );
534 printf( "%smodifying entry \"%s\"\n", dont ? "!" : "", dn->bv_val );
540 rc = ldap_add_ext( ld, dn->bv_val, pmods, pctrls, NULL, &msgid );
542 rc = ldap_modify_ext( ld, dn->bv_val, pmods, pctrls, NULL, &msgid );
545 if ( rc != LDAP_SUCCESS ) {
546 /* print error message about failed update including DN */
547 fprintf( stderr, _("%s: update failed: %s\n"), prog, dn->bv_val );
548 tool_perror( newentry ? "ldap_add" : "ldap_modify",
549 rc, NULL, NULL, NULL, NULL );
552 rc = process_response( ld, msgid,
553 newentry ? LDAP_RES_ADD : LDAP_RES_MODIFY, dn );
555 if ( verbose && rc == LDAP_SUCCESS ) {
556 printf( _("modify complete\n") );
571 const struct berval *dn,
572 LDAPControl **pctrls )
577 assert( dn != NULL );
578 assert( dn->bv_val != NULL );
579 printf( _("%sdeleting entry \"%s\"\n"), dont ? "!" : "", dn->bv_val );
581 rc = ldap_delete_ext( ld, dn->bv_val, pctrls, NULL, &msgid );
582 if ( rc != LDAP_SUCCESS ) {
583 fprintf( stderr, _("%s: delete failed: %s\n"), prog, dn->bv_val );
584 tool_perror( "ldap_delete", rc, NULL, NULL, NULL, NULL );
587 rc = process_response( ld, msgid, LDAP_RES_DELETE, dn );
589 if ( verbose && rc == LDAP_SUCCESS ) {
590 printf( _("delete complete\n") );
604 const struct berval *dn,
605 const struct berval *newrdn,
606 const struct berval *newsup,
608 LDAPControl **pctrls )
613 assert( dn != NULL );
614 assert( dn->bv_val != NULL );
615 assert( newrdn != NULL );
616 assert( newrdn->bv_val != NULL );
617 printf( _("%smodifying rdn of entry \"%s\"\n"), dont ? "!" : "", dn->bv_val );
619 printf( _("\tnew RDN: \"%s\" (%skeep existing values)\n"),
620 newrdn->bv_val, deleteoldrdn ? _("do not ") : "" );
623 rc = ldap_rename( ld, dn->bv_val, newrdn->bv_val,
624 ( newsup && newsup->bv_val ) ? newsup->bv_val : NULL,
625 deleteoldrdn, pctrls, NULL, &msgid );
626 if ( rc != LDAP_SUCCESS ) {
627 fprintf( stderr, _("%s: rename failed: %s\n"), prog, dn->bv_val );
628 tool_perror( "ldap_rename", rc, NULL, NULL, NULL, NULL );
631 rc = process_response( ld, msgid, LDAP_RES_RENAME, dn );
633 if ( verbose && rc == LDAP_SUCCESS ) {
634 printf( _("rename complete\n") );
650 case LDAP_RES_DELETE:
651 return "ldap_delete";
652 case LDAP_RES_MODIFY:
653 return "ldap_modify";
654 case LDAP_RES_MODRDN:
655 return "ldap_rename";
660 return "ldap_unknown";
663 static int process_response(
667 const struct berval *dn )
670 int rc = LDAP_OTHER, msgtype;
671 struct timeval tv = { 0, 0 };
673 char *text = NULL, *matched = NULL, **refs = NULL;
674 LDAPControl **ctrls = NULL;
676 assert( dn != NULL );
681 rc = ldap_result( ld, msgid, LDAP_MSG_ALL, &tv, &res );
682 if ( tool_check_abandon( ld, msgid ) ) {
683 return LDAP_CANCELLED;
687 ldap_get_option( ld, LDAP_OPT_RESULT_CODE, &rc );
688 tool_perror( "ldap_result", rc, NULL, NULL, NULL, NULL );
697 msgtype = ldap_msgtype( res );
699 rc = ldap_parse_result( ld, res, &err, &matched, &text, &refs, &ctrls, 1 );
700 if ( rc == LDAP_SUCCESS ) rc = err;
703 if ( rc == LDAP_X_TXN_SPECIFY_OKAY ) {
707 if ( rc != LDAP_SUCCESS ) {
708 tool_perror( res2str( op ), rc, NULL, matched, text, refs );
709 } else if ( msgtype != op ) {
710 fprintf( stderr, "%s: msgtype: expected %d got %d\n",
711 res2str( op ), op, msgtype );
715 if ( text ) ldap_memfree( text );
716 if ( matched ) ldap_memfree( matched );
717 if ( refs ) ber_memvfree( (void **)refs );
720 tool_print_ctrls( ld, ctrls );
721 ldap_controls_free( ctrls );