3 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
6 /* ldapmodify.c - generic program to modify or add entries using LDAP */
12 #include <ac/stdlib.h>
15 #include <ac/signal.h>
16 #include <ac/string.h>
17 #include <ac/unistd.h>
21 #ifdef HAVE_SYS_FILE_H
32 #include "ldap_defaults.h"
35 static char *binddn = NULL;
36 static char *passwd = NULL;
37 static char *ldaphost = NULL;
38 static int ldapport = 0;
39 static int new, replace, not, verbose, contoper, force, valsfromfiles;
42 #define LDAPMOD_MAXLINE 4096
44 /* strings found in replog/LDIF entries (mostly lifted from slurpd/slurp.h) */
45 #define T_VERSION_STR "version"
46 #define T_REPLICA_STR "replica"
48 #define T_CHANGETYPESTR "changetype"
49 #define T_ADDCTSTR "add"
50 #define T_MODIFYCTSTR "modify"
51 #define T_DELETECTSTR "delete"
52 #define T_MODRDNCTSTR "modrdn"
53 #define T_MODDNCTSTR "moddn"
54 #define T_RENAMECTSTR "rename"
55 #define T_MODOPADDSTR "add"
56 #define T_MODOPREPLACESTR "replace"
57 #define T_MODOPDELETESTR "delete"
58 #define T_MODSEPSTR "-"
59 #define T_NEWRDNSTR "newrdn"
60 #define T_DELETEOLDRDNSTR "deleteoldrdn"
61 #define T_NEWSUPSTR "newsuperior"
64 static void usage LDAP_P(( const char *prog )) LDAP_GCCATTR((noreturn));
65 static int process_ldapmod_rec LDAP_P(( char *rbuf ));
66 static int process_ldif_rec LDAP_P(( char *rbuf, int count ));
67 static void addmodifyop LDAP_P(( LDAPMod ***pmodsp, int modop, char *attr,
68 char *value, int vlen ));
69 static int domodify LDAP_P(( char *dn, LDAPMod **pmods, int newentry ));
70 static int dodelete LDAP_P(( char *dn ));
71 static int domodrdn LDAP_P(( char *dn, char *newrdn, int deleteoldrdn ));
72 static int fromfile LDAP_P(( char *path, struct berval *bv ));
73 static char *read_one_record LDAP_P(( FILE *fp ));
76 usage( const char *prog )
79 "Add or modify entries from an LDAP server\n\n"
80 "usage: %s [-abcknrvF] [-M[M]] [-d debug-level] [-P version] [-h ldaphost]\n"
81 " [-p ldapport] [-D binddn] [-w passwd] [ -f file | < entryfile ]\n"
82 " a - add values (default%s)\n"
83 " b - read values from files (for binary attributes)\n"
84 " c - continuous operation\n"
86 " M - enable Manage DSA IT control (-MM for critical)\n"
88 " f - read from file\n"
89 " F - force all changes records to be used\n"
91 " n - print adds, don't actually do them\n"
93 " r - replace values\n"
96 , prog, (strcmp( prog, "ldapadd" ) ? " is to replace" : "") );
102 main( int argc, char **argv )
104 char *infile, *rbuf, *start, *p, *q;
106 int rc, i, use_ldif, authmethod, version, want_bindpw, debug, manageDSAit;
109 if (( prog = strrchr( argv[ 0 ], *LDAP_DIRSEP )) == NULL ) {
115 /* Print usage when no parameters */
119 new = ( strcmp( prog, "ldapadd" ) == 0 );
122 not = verbose = valsfromfiles = want_bindpw = debug = manageDSAit = 0;
123 authmethod = LDAP_AUTH_SIMPLE;
126 while (( i = getopt( argc, argv, "WFMabckKnrtvh:p:D:w:d:f:P:" )) != EOF ) {
131 case 'b': /* read values from files (for binary attributes) */
134 case 'c': /* continuous operation */
137 case 'r': /* default is to replace rather than add values */
140 case 'k': /* kerberos bind */
141 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
142 authmethod = LDAP_AUTH_KRBV4;
144 fprintf (stderr, "%s was not compiled with Kerberos support\n", argv[0]);
146 return( EXIT_FAILURE );
149 case 'K': /* kerberos bind, part 1 only */
150 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
151 authmethod = LDAP_AUTH_KRBV41;
153 fprintf (stderr, "%s was not compiled with Kerberos support\n", argv[0]);
155 return( EXIT_FAILURE );
158 case 'F': /* force all changes records to be used */
161 case 'h': /* ldap host */
162 ldaphost = strdup( optarg );
164 case 'D': /* bind DN */
165 binddn = strdup( optarg );
167 case 'w': /* password */
168 passwd = strdup( optarg );
172 for( p = optarg; *p == '\0'; p++ ) {
178 debug |= atoi( optarg );
180 case 'f': /* read from file */
181 infile = strdup( optarg );
184 ldapport = atoi( optarg );
186 case 'n': /* print adds, don't actually do them */
189 case 'v': /* verbose mode */
193 /* enable Manage DSA IT */
200 switch( atoi(optarg) )
203 version = LDAP_VERSION2;
206 version = LDAP_VERSION3;
209 fprintf( stderr, "protocol version should be 2 or 3\n" );
218 if ( argc != optind )
221 if( authmethod != LDAP_AUTH_SIMPLE ) {
222 if( version == LDAP_VERSION3 ) {
223 fprintf(stderr, "Kerberos requires LDAPv2\n");
226 version = LDAP_VERSION2;
230 if( version == LDAP_VERSION2 ) {
231 fprintf(stderr, "manage DSA control requires LDAPv3\n");
234 version = LDAP_VERSION3;
237 if ( infile != NULL ) {
238 if (( fp = fopen( infile, "r" )) == NULL ) {
240 return( EXIT_FAILURE );
247 if( ber_set_option( NULL, LBER_OPT_DEBUG_LEVEL, &debug ) != LBER_OPT_SUCCESS ) {
248 fprintf( stderr, "Could not set LBER_OPT_DEBUG_LEVEL %d\n", debug );
250 if( ldap_set_option( NULL, LDAP_OPT_DEBUG_LEVEL, &debug ) != LDAP_OPT_SUCCESS ) {
251 fprintf( stderr, "Could not set LDAP_OPT_DEBUG_LEVEL %d\n", debug );
257 (void) SIGNAL( SIGPIPE, SIG_IGN );
261 if (( ld = ldap_init( ldaphost, ldapport )) == NULL ) {
262 perror( "ldap_init" );
263 return( EXIT_FAILURE );
266 /* this seems prudent */
268 int deref = LDAP_DEREF_NEVER;
269 ldap_set_option( ld, LDAP_OPT_DEREF, &deref);
271 /* don't chase referrals */
272 ldap_set_option( ld, LDAP_OPT_REFERRALS, LDAP_OPT_OFF );
275 ldap_set_option( ld, LDAP_OPT_PROTOCOL_VERSION, &version ) != LDAP_OPT_SUCCESS)
277 fprintf( stderr, "Could not set LDAP_OPT_PROTOCOL_VERSION to %d\n", version );
281 passwd = getpass("Enter LDAP Password: ");
283 if ( ldap_bind_s( ld, binddn, passwd, authmethod ) != LDAP_SUCCESS ) {
284 ldap_perror( ld, "ldap_bind" );
285 return( EXIT_FAILURE );
294 LDAPControl *ctrls[2];
298 c.ldctl_oid = LDAP_CONTROL_MANAGEDSAIT;
299 c.ldctl_value.bv_val = NULL;
300 c.ldctl_value.bv_len = 0;
301 c.ldctl_iscritical = manageDSAit > 1;
303 err = ldap_set_option( ld, LDAP_OPT_SERVER_CONTROLS, &ctrls );
305 if( err != LDAP_OPT_SUCCESS ) {
306 fprintf( stderr, "Could not set Manage DSA IT Control\n" );
307 if( c.ldctl_iscritical ) {
308 exit( EXIT_FAILURE );
314 while (( rc == 0 || contoper ) &&
315 ( rbuf = read_one_record( fp )) != NULL ) {
318 * we assume record is ldif/slapd.replog if the first line
319 * has a colon that appears to the left of any equal signs, OR
320 * if the first line consists entirely of digits (an entry id)
325 use_ldif = ( *rbuf == '#' ) ||
326 (( p = strchr( rbuf, ':' )) != NULL &&
327 ( q = strchr( rbuf, '\n' )) != NULL && p < q &&
328 (( q = strchr( rbuf, '=' )) == NULL || p < q ));
333 if ( !use_ldif && ( q = strchr( rbuf, '\n' )) != NULL ) {
334 for ( p = rbuf; p < q; ++p ) {
335 if ( !isdigit( (unsigned char) *p )) {
346 rc = process_ldif_rec( start, count );
348 rc = process_ldapmod_rec( start );
352 fprintf( stderr, "%s() = %d\n",
353 use_ldif ? "ldif_rec" : "ldapmod_rec" , rc );
367 process_ldif_rec( char *rbuf, int count )
369 char *line, *dn, *type, *value, *newrdn, *newsup, *p;
370 int rc, linenum, modop, replicaport;
372 int expect_modop, expect_sep, expect_ct, expect_newrdn, expect_newsup;
373 int expect_deleteoldrdn, deleteoldrdn;
374 int saw_replica, use_record, new_entry, delete_entry, got_all;
380 rc = got_all = saw_replica = delete_entry = expect_modop = 0;
381 expect_deleteoldrdn = expect_newrdn = expect_newsup = 0;
382 expect_sep = expect_ct = 0;
388 dn = newrdn = newsup = NULL;
390 while ( rc == 0 && ( line = ldif_getline( &rbuf )) != NULL ) {
393 if ( expect_sep && strcasecmp( line, T_MODSEPSTR ) == 0 ) {
399 if ( ldif_parse_line( line, &type, &value, &vlen ) < 0 ) {
400 fprintf( stderr, "%s: invalid format (line %d) entry: \"%s\"\n",
401 prog, linenum, dn == NULL ? "" : dn );
402 rc = LDAP_PARAM_ERROR;
407 if ( !use_record && strcasecmp( type, T_REPLICA_STR ) == 0 ) {
409 if (( p = strchr( value, ':' )) == NULL ) {
413 replicaport = atoi( p );
415 if ( ldaphost != NULL && strcasecmp( value, ldaphost ) == 0 &&
416 replicaport == ldapport ) {
419 } else if ( count == 1 && linenum == 1 &&
420 strcasecmp( type, T_VERSION_STR ) == 0 )
422 if( vlen == 0 || atoi(value) != 1 ) {
423 fprintf( stderr, "%s: invalid version %s, line %d (ignored)\n",
424 prog, value == NULL ? "(null)" : value, linenum );
428 } else if ( strcasecmp( type, T_DN_STR ) == 0 ) {
429 if (( dn = strdup( value ? value : "" )) == NULL ) {
431 exit( EXIT_FAILURE );
435 goto end_line; /* skip all lines until we see "dn:" */
440 if ( !use_record && saw_replica ) {
441 printf( "%s: skipping change record for entry: %s\n"
442 "\t(LDAP host/port does not match replica: lines)\n",
446 ber_memfree( value );
450 if ( strcasecmp( type, T_CHANGETYPESTR ) == 0 ) {
451 if ( strcasecmp( value, T_MODIFYCTSTR ) == 0 ) {
454 } else if ( strcasecmp( value, T_ADDCTSTR ) == 0 ) {
456 } else if ( strcasecmp( value, T_MODRDNCTSTR ) == 0
457 || strcasecmp( value, T_MODDNCTSTR ) == 0
458 || strcasecmp( value, T_RENAMECTSTR ) == 0)
461 } else if ( strcasecmp( value, T_DELETECTSTR ) == 0 ) {
462 got_all = delete_entry = 1;
465 "%s: unknown %s \"%s\" (line %d of entry \"%s\")\n",
466 prog, T_CHANGETYPESTR, value, linenum, dn );
467 rc = LDAP_PARAM_ERROR;
470 } else if ( new ) { /* missing changetype => add */
472 modop = LDAP_MOD_ADD;
474 expect_modop = 1; /* missing changetype => modify */
478 if ( expect_modop ) {
481 if ( strcasecmp( type, T_MODOPADDSTR ) == 0 ) {
482 modop = LDAP_MOD_ADD;
484 } else if ( strcasecmp( type, T_MODOPREPLACESTR ) == 0 ) {
485 modop = LDAP_MOD_REPLACE;
486 addmodifyop( &pmods, modop, value, NULL, 0 );
488 } else if ( strcasecmp( type, T_MODOPDELETESTR ) == 0 ) {
489 modop = LDAP_MOD_DELETE;
490 addmodifyop( &pmods, modop, value, NULL, 0 );
492 } else { /* no modify op: use default */
493 modop = replace ? LDAP_MOD_REPLACE : LDAP_MOD_ADD;
497 if ( expect_newrdn ) {
498 if ( strcasecmp( type, T_NEWRDNSTR ) == 0 ) {
499 if (( newrdn = strdup( value )) == NULL ) {
501 exit( EXIT_FAILURE );
503 expect_deleteoldrdn = 1;
506 fprintf( stderr, "%s: expecting \"%s:\" but saw \"%s:\" (line %d of entry \"%s\")\n",
507 prog, T_NEWRDNSTR, type, linenum, dn );
508 rc = LDAP_PARAM_ERROR;
510 } else if ( expect_deleteoldrdn ) {
511 if ( strcasecmp( type, T_DELETEOLDRDNSTR ) == 0 ) {
512 deleteoldrdn = ( *value == '0' ) ? 0 : 1;
513 expect_deleteoldrdn = 0;
517 fprintf( stderr, "%s: expecting \"%s:\" but saw \"%s:\" (line %d of entry \"%s\")\n",
518 prog, T_DELETEOLDRDNSTR, type, linenum, dn );
519 rc = LDAP_PARAM_ERROR;
521 } else if ( expect_newsup ) {
522 if ( strcasecmp( type, T_NEWSUPSTR ) == 0 ) {
523 if (( newsup = strdup( value )) == NULL ) {
525 exit( EXIT_FAILURE );
529 fprintf( stderr, "%s: expecting \"%s:\" but saw \"%s:\" (line %d of entry \"%s\")\n",
530 prog, T_NEWSUPSTR, type, linenum, dn );
531 rc = LDAP_PARAM_ERROR;
533 } else if ( got_all ) {
535 "%s: extra lines at end (line %d of entry \"%s\")\n",
537 rc = LDAP_PARAM_ERROR;
539 addmodifyop( &pmods, modop, type, value, vlen );
544 ber_memfree( value );
551 if( version && linenum == 1 ) {
556 if ( delete_entry ) {
558 } else if ( newrdn != NULL ) {
559 rc = domodrdn( dn, newrdn, deleteoldrdn );
561 rc = domodify( dn, pmods, new_entry );
564 if ( rc == LDAP_SUCCESS ) {
572 if ( newrdn != NULL ) {
575 if ( pmods != NULL ) {
576 ldap_mods_free( pmods, 1 );
584 process_ldapmod_rec( char *rbuf )
586 char *line, *dn, *p, *q, *attr, *value;
587 int rc, linenum, modop;
596 while ( rc == 0 && rbuf != NULL && *rbuf != '\0' ) {
598 if (( p = strchr( rbuf, '\n' )) == NULL ) {
601 if ( *(p-1) == '\\' ) { /* lines ending in '\' are continued */
602 SAFEMEMCPY( p - 1, p, strlen( p ) + 1 );
610 if ( dn == NULL ) { /* first line contains DN */
611 if (( dn = strdup( line )) == NULL ) {
613 exit( EXIT_FAILURE );
616 if (( p = strchr( line, '=' )) == NULL ) {
618 p = line + strlen( line );
625 *attr != '\0' && isspace( (unsigned char) *attr ); ++attr ) {
626 ; /* skip attribute leading white space */
629 for ( q = p - 1; q > attr && isspace( (unsigned char) *q ); --q ) {
630 *q = '\0'; /* remove attribute trailing white space */
633 if ( value != NULL ) {
634 while ( isspace( (unsigned char) *value )) {
635 ++value; /* skip value leading white space */
637 for ( q = value + strlen( value ) - 1; q > value &&
638 isspace( (unsigned char) *q ); --q ) {
639 *q = '\0'; /* remove value trailing white space */
641 if ( *value == '\0' ) {
647 if ( value == NULL && new ) {
648 fprintf( stderr, "%s: missing value on line %d (attr=\"%s\")\n",
649 prog, linenum, attr );
650 rc = LDAP_PARAM_ERROR;
654 modop = LDAP_MOD_DELETE;
658 modop = LDAP_MOD_ADD;
662 modop = replace ? LDAP_MOD_REPLACE : LDAP_MOD_ADD;
665 addmodifyop( &pmods, modop, attr, value,
666 ( value == NULL ) ? 0 : strlen( value ));
675 rc = LDAP_PARAM_ERROR;
676 } else if (( rc = domodify( dn, pmods, new )) == LDAP_SUCCESS ) {
681 if ( pmods != NULL ) {
682 ldap_mods_free( pmods, 1 );
693 addmodifyop( LDAPMod ***pmodsp, int modop, char *attr, char *value, int vlen )
700 modop |= LDAP_MOD_BVALUES;
703 if ( pmods != NULL ) {
704 for ( ; pmods[ i ] != NULL; ++i ) {
705 if ( strcasecmp( pmods[ i ]->mod_type, attr ) == 0 &&
706 pmods[ i ]->mod_op == modop ) {
712 if ( pmods == NULL || pmods[ i ] == NULL ) {
713 if (( pmods = (LDAPMod **)ber_memrealloc( pmods, (i + 2) *
714 sizeof( LDAPMod * ))) == NULL ) {
716 exit( EXIT_FAILURE );
719 pmods[ i + 1 ] = NULL;
720 if (( pmods[ i ] = (LDAPMod *)ber_memcalloc( 1, sizeof( LDAPMod )))
723 exit( EXIT_FAILURE );
725 pmods[ i ]->mod_op = modop;
726 if (( pmods[ i ]->mod_type = ber_strdup( attr )) == NULL ) {
728 exit( EXIT_FAILURE );
732 if ( value != NULL ) {
734 if ( pmods[ i ]->mod_bvalues != NULL ) {
735 for ( ; pmods[ i ]->mod_bvalues[ j ] != NULL; ++j ) {
739 if (( pmods[ i ]->mod_bvalues =
740 (struct berval **)ber_memrealloc( pmods[ i ]->mod_bvalues,
741 (j + 2) * sizeof( struct berval * ))) == NULL ) {
742 perror( "ber_realloc" );
743 exit( EXIT_FAILURE );
745 pmods[ i ]->mod_bvalues[ j + 1 ] = NULL;
746 if (( bvp = (struct berval *)ber_memalloc( sizeof( struct berval )))
748 perror( "ber_memalloc" );
749 exit( EXIT_FAILURE );
751 pmods[ i ]->mod_bvalues[ j ] = bvp;
753 if ( valsfromfiles && *value == '/' ) { /* get value from file */
754 if ( fromfile( value, bvp ) < 0 ) {
755 exit( EXIT_FAILURE );
759 if (( bvp->bv_val = (char *)ber_memalloc( vlen + 1 )) == NULL ) {
761 exit( EXIT_FAILURE );
763 SAFEMEMCPY( bvp->bv_val, value, vlen );
764 bvp->bv_val[ vlen ] = '\0';
771 domodify( char *dn, LDAPMod **pmods, int newentry )
773 int i, j, k, notascii, op;
776 if ( pmods == NULL ) {
777 fprintf( stderr, "%s: no attributes to change or add (entry=\"%s\")\n",
779 return( LDAP_PARAM_ERROR );
783 for ( i = 0; pmods[ i ] != NULL; ++i ) {
784 op = pmods[ i ]->mod_op & ~LDAP_MOD_BVALUES;
785 printf( "%s %s:\n", op == LDAP_MOD_REPLACE ?
786 "replace" : op == LDAP_MOD_ADD ?
787 "add" : "delete", pmods[ i ]->mod_type );
788 if ( pmods[ i ]->mod_bvalues != NULL ) {
789 for ( j = 0; pmods[ i ]->mod_bvalues[ j ] != NULL; ++j ) {
790 bvp = pmods[ i ]->mod_bvalues[ j ];
792 for ( k = 0; (unsigned long) k < bvp->bv_len; ++k ) {
793 if ( !isascii( bvp->bv_val[ k ] )) {
799 printf( "\tNOT ASCII (%ld bytes)\n", bvp->bv_len );
801 printf( "\t%s\n", bvp->bv_val );
809 printf( "%sadding new entry \"%s\"\n", not ? "!" : "", dn );
811 printf( "%smodifying entry \"%s\"\n", not ? "!" : "", dn );
816 i = ldap_add_s( ld, dn, pmods );
818 i = ldap_modify_s( ld, dn, pmods );
820 if ( i != LDAP_SUCCESS ) {
821 ldap_perror( ld, newentry ? "ldap_add" : "ldap_modify" );
822 } else if ( verbose ) {
823 printf( "modify complete\n" );
840 printf( "%sdeleting entry \"%s\"\n", not ? "!" : "", dn );
842 if (( rc = ldap_delete_s( ld, dn )) != LDAP_SUCCESS ) {
843 ldap_perror( ld, "ldap_delete" );
844 } else if ( verbose ) {
845 printf( "delete complete" );
858 domodrdn( char *dn, char *newrdn, int deleteoldrdn )
863 printf( "%smodifying rdn of entry \"%s\"\n", not ? "!" : "", dn );
865 printf( "\tnew RDN: \"%s\" (%skeep existing values)\n",
866 newrdn, deleteoldrdn ? "do not " : "" );
869 if (( rc = ldap_modrdn2_s( ld, dn, newrdn, deleteoldrdn ))
871 ldap_perror( ld, "ldap_modrdn" );
873 printf( "modrdn completed\n" );
886 fromfile( char *path, struct berval *bv )
892 if (( fp = fopen( path, "r" )) == NULL ) {
897 if ( fseek( fp, 0L, SEEK_END ) != 0 ) {
903 bv->bv_len = ftell( fp );
905 if (( bv->bv_val = (char *)ber_memalloc( bv->bv_len )) == NULL ) {
911 if ( fseek( fp, 0L, SEEK_SET ) != 0 ) {
914 ber_memfree( bv->bv_val );
919 rlen = fread( bv->bv_val, 1, bv->bv_len, fp );
923 if ( (unsigned long) rlen != bv->bv_len ) {
925 ber_memfree( bv->bv_val );
930 return( bv->bv_len );
935 read_one_record( FILE *fp )
937 char *buf, line[ LDAPMOD_MAXLINE ];
943 while ( fgets( line, sizeof(line), fp ) != NULL ) {
944 int len = strlen( line );
954 if ( lcur + len + 1 > lmax ) {
955 lmax = LDAPMOD_MAXLINE
956 * (( lcur + len + 1 ) / LDAPMOD_MAXLINE + 1 );
958 if (( buf = (char *)realloc( buf, lmax )) == NULL ) {
960 exit( EXIT_FAILURE );
964 strcpy( buf + lcur, line );