3 * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
6 /* ldapmodrdn.c - generic program to modify an entry's RDN using LDAP.
8 * Support for MODIFYDN REQUEST V3 (newSuperior) by:
10 * Copyright 1999, Juan C. Gomez, All rights reserved.
11 * This software is not subject to any license of Silicon Graphics
12 * Inc. or Purdue University.
14 * Redistribution and use in source and binary forms are permitted
15 * without restriction or fee of any kind as long as this notice
24 #include <ac/stdlib.h>
27 #include <ac/signal.h>
28 #include <ac/string.h>
29 #include <ac/unistd.h>
33 #include "lutil_ldap.h"
34 #include "ldap_defaults.h"
36 static char *prog = NULL;
37 static char *binddn = NULL;
38 static struct berval passwd = { 0, NULL };
39 static char *ldapuri = NULL;
40 static char *ldaphost = NULL;
41 static int ldapport = 0;
42 #ifdef HAVE_CYRUS_SASL
43 static unsigned sasl_flags = LDAP_SASL_AUTOMATIC;
44 static char *sasl_realm = NULL;
45 static char *sasl_authc_id = NULL;
46 static char *sasl_authz_id = NULL;
47 static char *sasl_mech = NULL;
48 static char *sasl_secprops = NULL;
50 static int use_tls = 0;
51 static int not, verbose, contoper;
52 static LDAP *ld = NULL;
59 int remove ); /* flag: remove old RDN */
62 usage( const char *s )
65 "Rename LDAP entries\n\n"
66 "usage: %s [options] [dn rdn]\n"
67 " dn rdn: If given, rdn will replace the RDN of the entry specified by DN\n"
68 " If not given, the list of modifications is read from stdin or\n"
69 " from the file specified by \"-f file\" (see man page).\n"
71 " -c continuous operation mode (do not stop on errors)\n"
72 " -f file read operations from `file'\n"
73 " -r remove old RDN\n"
74 " -s newsup new superior entry\n"
77 " -d level set LDAP debugging level to `level'\n"
78 " -D binddn bind DN\n"
79 " -e [!]<ctrl>[=<ctrlparam>] general controls (! indicates criticality)\n"
80 " [!]authzid=<authzid> (\"dn:<dn>\" or \"u:<user>\")\n"
81 " [!]manageDSAit (alternate form, see -M)\n"
83 " -f file read operations from `file'\n"
84 " -h host LDAP server\n"
85 " -H URI LDAP Uniform Resource Indentifier(s)\n"
86 " -I use SASL Interactive mode\n"
87 " -k use Kerberos authentication\n"
88 " -K like -k, but do only step 1 of the Kerberos bind\n"
89 " -M enable Manage DSA IT control (-MM to make critical)\n"
90 " -n show what would be done but don't actually update\n"
91 " -O props SASL security properties\n"
92 " -p port port on LDAP server\n"
93 " -P version procotol version (default: 3)\n"
94 " -Q use SASL Quiet mode\n"
95 " -R realm SASL realm\n"
96 " -U authzid SASL authentication identity\n"
97 " -v run in verbose mode (diagnostics to standard output)\n"
98 " -w passwd bind passwd (for simple authentication)\n"
99 " -W prompt for bind passwd\n"
100 " -x Simple authentication\n"
101 " -X authzid SASL authorization identity (\"dn:<dn>\" or \"u:<user>\")\n"
102 " -y file Read passwd from file\n"
103 " -Y mech SASL mechanism\n"
104 " -Z Start TLS request (-ZZ to require successful response)\n"
107 exit( EXIT_FAILURE );
111 main(int argc, char **argv)
113 char *infile, *entrydn = NULL, *rdn = NULL, buf[ 4096 ];
115 int rc, i, remove, havedn, authmethod, version, want_bindpw, debug, manageDSAit, noop, crit;
117 char *newSuperior=NULL;
118 char *pw_file = NULL;
119 char *control, *cvalue;
120 char *authzid = NULL;
123 not = contoper = verbose = remove = want_bindpw =
124 debug = manageDSAit = noop = referrals = 0;
128 prog = lutil_progname( "ldapmodrdn", argc, argv );
130 while (( i = getopt( argc, argv, "cf:rs:"
131 "Cd:D:e:h:H:IkKMnO:p:P:QR:U:vw:WxX:y:Y:Z" )) != EOF )
138 case 'E': /* modrdn controls */
139 if( version == LDAP_VERSION2 ) {
140 fprintf( stderr, "%s: -E incompatible with LDAPv%d\n",
145 /* should be extended to support comma separated list of
146 * [!]key[=value] parameters, e.g. -E !foo,bar=567
151 if( optarg[0] == '!' ) {
156 control = strdup( optarg );
157 if ( (cvalue = strchr( control, '=' )) != NULL ) {
160 fprintf( stderr, "Invalid modrdn control name: %s\n", control );
163 case 'f': /* read from file */
164 if( infile != NULL ) {
165 fprintf( stderr, "%s: -f previously specified\n", prog );
168 infile = strdup( optarg );
170 case 'r': /* remove old RDN */
173 case 's': /* newSuperior */
174 if( version == LDAP_VERSION2 ) {
175 fprintf( stderr, "%s: -X incompatible with LDAPv%d\n",
179 newSuperior = strdup( optarg );
180 version = LDAP_VERSION3;
188 debug |= atoi( optarg );
190 case 'D': /* bind DN */
191 if( binddn != NULL ) {
192 fprintf( stderr, "%s: -D previously specified\n", prog );
195 binddn = strdup( optarg );
197 case 'e': /* general controls */
198 if( version == LDAP_VERSION2 ) {
199 fprintf( stderr, "%s: -e incompatible with LDAPv%d\n",
204 /* should be extended to support comma separated list of
205 * [!]key[=value] parameters, e.g. -e !foo,bar=567
210 if( optarg[0] == '!' ) {
215 control = strdup( optarg );
216 if ( (cvalue = strchr( control, '=' )) != NULL ) {
220 if ( strcasecmp( control, "manageDSAit" ) == 0 ) {
222 fprintf( stderr, "manageDSAit control previously specified");
225 if( cvalue != NULL ) {
226 fprintf( stderr, "manageDSAit: no control value expected" );
231 manageDSAit = 1 + crit;
234 } else if ( strcasecmp( control, "noop" ) == 0 ) {
236 fprintf( stderr, "noop control previously specified");
239 if( cvalue != NULL ) {
240 fprintf( stderr, "noop: no control value expected" );
249 fprintf( stderr, "Invalid general control name: %s\n", control );
253 case 'h': /* ldap host */
254 if( ldapuri != NULL ) {
255 fprintf( stderr, "%s: -h incompatible with -H\n", prog );
258 if( ldaphost != NULL ) {
259 fprintf( stderr, "%s: -h previously specified\n", prog );
262 ldaphost = strdup( optarg );
264 case 'H': /* ldap URI */
265 if( ldaphost != NULL ) {
266 fprintf( stderr, "%s: -H incompatible with -h\n", prog );
270 fprintf( stderr, "%s: -H incompatible with -p\n", prog );
273 if( ldapuri != NULL ) {
274 fprintf( stderr, "%s: -H previously specified\n", prog );
277 ldapuri = strdup( optarg );
280 #ifdef HAVE_CYRUS_SASL
281 if( version == LDAP_VERSION2 ) {
282 fprintf( stderr, "%s: -I incompatible with version %d\n",
286 if( authmethod != -1 && authmethod != LDAP_AUTH_SASL ) {
287 fprintf( stderr, "%s: incompatible previous "
288 "authentication choice\n",
292 authmethod = LDAP_AUTH_SASL;
293 version = LDAP_VERSION3;
294 sasl_flags = LDAP_SASL_INTERACTIVE;
297 fprintf( stderr, "%s: was not compiled with SASL support\n",
299 return( EXIT_FAILURE );
301 case 'k': /* kerberos bind */
302 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
303 if( version > LDAP_VERSION2 ) {
304 fprintf( stderr, "%s: -k incompatible with LDAPv%d\n",
309 if( authmethod != -1 ) {
310 fprintf( stderr, "%s: -k incompatible with previous "
311 "authentication choice\n", prog );
315 authmethod = LDAP_AUTH_KRBV4;
317 fprintf( stderr, "%s: not compiled with Kerberos support\n", prog );
321 case 'K': /* kerberos bind, part one only */
322 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
323 if( version > LDAP_VERSION2 ) {
324 fprintf( stderr, "%s: -k incompatible with LDAPv%d\n",
328 if( authmethod != -1 ) {
329 fprintf( stderr, "%s: incompatible with previous "
330 "authentication choice\n", prog );
334 authmethod = LDAP_AUTH_KRBV41;
336 fprintf( stderr, "%s: not compiled with Kerberos support\n", prog );
337 return( EXIT_FAILURE );
341 /* enable Manage DSA IT */
342 if( version == LDAP_VERSION2 ) {
343 fprintf( stderr, "%s: -M incompatible with LDAPv%d\n",
348 version = LDAP_VERSION3;
350 case 'n': /* print deletes, don't actually do them */
354 #ifdef HAVE_CYRUS_SASL
355 if( sasl_secprops != NULL ) {
356 fprintf( stderr, "%s: -O previously specified\n", prog );
359 if( version == LDAP_VERSION2 ) {
360 fprintf( stderr, "%s: -O incompatible with LDAPv%d\n",
364 if( authmethod != -1 && authmethod != LDAP_AUTH_SASL ) {
365 fprintf( stderr, "%s: incompatible previous "
366 "authentication choice\n", prog );
369 authmethod = LDAP_AUTH_SASL;
370 version = LDAP_VERSION3;
371 sasl_secprops = strdup( optarg );
373 fprintf( stderr, "%s: not compiled with SASL support\n",
375 return( EXIT_FAILURE );
380 fprintf( stderr, "%s: -p previously specified\n", prog );
383 ldapport = atoi( optarg );
386 switch( atoi(optarg) ) {
388 if( version == LDAP_VERSION3 ) {
389 fprintf( stderr, "%s: -P 2 incompatible with version %d\n",
393 version = LDAP_VERSION2;
396 if( version == LDAP_VERSION2 ) {
397 fprintf( stderr, "%s: -P 2 incompatible with version %d\n",
401 version = LDAP_VERSION3;
404 fprintf( stderr, "%s: protocol version should be 2 or 3\n",
407 return( EXIT_FAILURE );
410 #ifdef HAVE_CYRUS_SASL
411 if( version == LDAP_VERSION2 ) {
412 fprintf( stderr, "%s: -Q incompatible with version %d\n",
416 if( authmethod != -1 && authmethod != LDAP_AUTH_SASL ) {
417 fprintf( stderr, "%s: incompatible previous "
418 "authentication choice\n",
422 authmethod = LDAP_AUTH_SASL;
423 version = LDAP_VERSION3;
424 sasl_flags = LDAP_SASL_QUIET;
427 fprintf( stderr, "%s: not compiled with SASL support\n",
429 return( EXIT_FAILURE );
432 #ifdef HAVE_CYRUS_SASL
433 if( sasl_realm != NULL ) {
434 fprintf( stderr, "%s: -R previously specified\n", prog );
437 if( version == LDAP_VERSION2 ) {
438 fprintf( stderr, "%s: -R incompatible with version %d\n",
442 if( authmethod != -1 && authmethod != LDAP_AUTH_SASL ) {
443 fprintf( stderr, "%s: incompatible previous "
444 "authentication choice\n",
448 authmethod = LDAP_AUTH_SASL;
449 version = LDAP_VERSION3;
450 sasl_realm = strdup( optarg );
452 fprintf( stderr, "%s: not compiled with SASL support\n",
454 return( EXIT_FAILURE );
458 #ifdef HAVE_CYRUS_SASL
459 if( sasl_authc_id != NULL ) {
460 fprintf( stderr, "%s: -U previously specified\n", prog );
463 if( version == LDAP_VERSION2 ) {
464 fprintf( stderr, "%s: -U incompatible with version %d\n",
468 if( authmethod != -1 && authmethod != LDAP_AUTH_SASL ) {
469 fprintf( stderr, "%s: incompatible previous "
470 "authentication choice\n",
474 authmethod = LDAP_AUTH_SASL;
475 version = LDAP_VERSION3;
476 sasl_authc_id = strdup( optarg );
478 fprintf( stderr, "%s: not compiled with SASL support\n",
480 return( EXIT_FAILURE );
483 case 'v': /* verbose mode */
486 case 'w': /* password */
487 passwd.bv_val = strdup( optarg );
491 for( p = optarg; *p != '\0'; p++ ) {
495 passwd.bv_len = strlen( passwd.bv_val );
504 #ifdef HAVE_CYRUS_SASL
505 if( sasl_mech != NULL ) {
506 fprintf( stderr, "%s: -Y previously specified\n", prog );
509 if( version == LDAP_VERSION2 ) {
510 fprintf( stderr, "%s: -Y incompatible with version %d\n",
514 if( authmethod != -1 && authmethod != LDAP_AUTH_SASL ) {
515 fprintf( stderr, "%s: incompatible with authentication choice\n", prog );
518 authmethod = LDAP_AUTH_SASL;
519 version = LDAP_VERSION3;
520 sasl_mech = strdup( optarg );
522 fprintf( stderr, "%s: not compiled with SASL support\n",
524 return( EXIT_FAILURE );
528 if( authmethod != -1 && authmethod != LDAP_AUTH_SIMPLE ) {
529 fprintf( stderr, "%s: incompatible with previous "
530 "authentication choice\n", prog );
533 authmethod = LDAP_AUTH_SIMPLE;
536 #ifdef HAVE_CYRUS_SASL
537 if( sasl_authz_id != NULL ) {
538 fprintf( stderr, "%s: -X previously specified\n", prog );
541 if( version == LDAP_VERSION2 ) {
542 fprintf( stderr, "%s: -X incompatible with LDAPv%d\n",
546 if( authmethod != -1 && authmethod != LDAP_AUTH_SASL ) {
547 fprintf( stderr, "%s: -X incompatible with "
548 "authentication choice\n", prog );
551 authmethod = LDAP_AUTH_SASL;
552 version = LDAP_VERSION3;
553 sasl_authz_id = strdup( optarg );
555 fprintf( stderr, "%s: not compiled with SASL support\n",
557 return( EXIT_FAILURE );
562 if( version == LDAP_VERSION2 ) {
563 fprintf( stderr, "%s: -Z incompatible with version %d\n",
567 version = LDAP_VERSION3;
570 fprintf( stderr, "%s: not compiled with TLS support\n",
572 return( EXIT_FAILURE );
576 fprintf( stderr, "%s: unrecognized option -%c\n",
579 return( EXIT_FAILURE );
584 version = LDAP_VERSION3;
586 if (authmethod == -1 && version > LDAP_VERSION2) {
587 #ifdef HAVE_CYRUS_SASL
588 authmethod = LDAP_AUTH_SASL;
590 authmethod = LDAP_AUTH_SIMPLE;
595 if (argc - optind == 2) {
596 if (( rdn = strdup( argv[argc - 1] )) == NULL ) {
598 return( EXIT_FAILURE );
600 if (( entrydn = strdup( argv[argc - 2] )) == NULL ) {
602 return( EXIT_FAILURE );
605 } else if ( argc - optind != 0 ) {
606 fprintf( stderr, "%s: invalid number of arguments (%d), "
607 "only two allowed\n", prog, argc-optind );
609 return( EXIT_FAILURE );
612 if ( infile != NULL ) {
613 if (( fp = fopen( infile, "r" )) == NULL ) {
615 return( EXIT_FAILURE );
622 if( ber_set_option( NULL, LBER_OPT_DEBUG_LEVEL, &debug ) != LBER_OPT_SUCCESS ) {
623 fprintf( stderr, "Could not set LBER_OPT_DEBUG_LEVEL %d\n", debug );
625 if( ldap_set_option( NULL, LDAP_OPT_DEBUG_LEVEL, &debug ) != LDAP_OPT_SUCCESS ) {
626 fprintf( stderr, "Could not set LDAP_OPT_DEBUG_LEVEL %d\n", debug );
631 (void) SIGNAL( SIGPIPE, SIG_IGN );
634 if( ( ldaphost != NULL || ldapport ) && ( ldapuri == NULL ) ) {
636 fprintf( stderr, "ldap_init( %s, %d )\n",
637 ldaphost != NULL ? ldaphost : "<DEFAULT>",
641 ld = ldap_init( ldaphost, ldapport );
643 perror("ldapmodify: ldap_init");
649 fprintf( stderr, "ldap_initialize( %s )\n",
650 ldapuri != NULL ? ldapuri : "<DEFAULT>" );
653 rc = ldap_initialize( &ld, ldapuri );
654 if( rc != LDAP_SUCCESS ) {
655 fprintf( stderr, "Could not create LDAP session handle (%d): %s\n",
656 rc, ldap_err2string(rc) );
662 if( ldap_set_option( ld, LDAP_OPT_REFERRALS,
663 referrals ? LDAP_OPT_ON : LDAP_OPT_OFF ) != LDAP_OPT_SUCCESS )
665 fprintf( stderr, "Could not set LDAP_OPT_REFERRALS %s\n",
666 referrals ? "on" : "off" );
670 if( ldap_set_option( ld, LDAP_OPT_PROTOCOL_VERSION, &version )
671 != LDAP_OPT_SUCCESS )
673 fprintf( stderr, "Could not set LDAP_OPT_PROTOCOL_VERSION %d\n",
678 if ( use_tls && ( ldap_start_tls_s( ld, NULL, NULL ) != LDAP_SUCCESS )) {
679 ldap_perror( ld, "ldap_start_tls" );
681 return( EXIT_FAILURE );
685 if ( pw_file || want_bindpw ) {
687 rc = lutil_get_filed_password( pw_file, &passwd );
688 if( rc ) return EXIT_FAILURE;
690 passwd.bv_val = getpassphrase( "Enter LDAP Password: " );
691 passwd.bv_len = passwd.bv_val ? strlen( passwd.bv_val ) : 0;
695 if ( authmethod == LDAP_AUTH_SASL ) {
696 #ifdef HAVE_CYRUS_SASL
699 if( sasl_secprops != NULL ) {
700 rc = ldap_set_option( ld, LDAP_OPT_X_SASL_SECPROPS,
701 (void *) sasl_secprops );
703 if( rc != LDAP_OPT_SUCCESS ) {
705 "Could not set LDAP_OPT_X_SASL_SECPROPS: %s\n",
707 return( EXIT_FAILURE );
711 defaults = lutil_sasl_defaults( ld,
718 rc = ldap_sasl_interactive_bind_s( ld, binddn,
719 sasl_mech, NULL, NULL,
720 sasl_flags, lutil_sasl_interact, defaults );
722 if( rc != LDAP_SUCCESS ) {
723 ldap_perror( ld, "ldap_sasl_interactive_bind_s" );
724 return( EXIT_FAILURE );
727 fprintf( stderr, "%s: not compiled with SASL support\n",
729 return( EXIT_FAILURE );
733 if ( ldap_bind_s( ld, binddn, passwd.bv_val, authmethod )
735 ldap_perror( ld, "ldap_bind" );
736 return( EXIT_FAILURE );
740 if ( authzid || manageDSAit || noop ) {
741 int err, crit=0, i=0;
743 LDAPControl *ctrls[4];
746 c[i].ldctl_oid = LDAP_CONTROL_PROXY_AUTHZ;
747 c[i].ldctl_value.bv_val = authzid;
748 c[i].ldctl_value.bv_len = strlen( authzid );
749 c[i].ldctl_iscritical = 1;
751 if( c[i].ldctl_iscritical ) crit++;
757 c[i].ldctl_oid = LDAP_CONTROL_MANAGEDSAIT;
758 c[i].ldctl_value.bv_val = NULL;
759 c[i].ldctl_value.bv_len = 0;
760 c[i].ldctl_iscritical = manageDSAit > 1;
762 if( c[i].ldctl_iscritical ) crit++;
768 c[i].ldctl_oid = LDAP_CONTROL_NOOP;
769 c[i].ldctl_value.bv_val = NULL;
770 c[i].ldctl_value.bv_len = 0;
771 c[i].ldctl_iscritical = noop > 1;
773 if( c[i].ldctl_iscritical ) crit++;
778 err = ldap_set_option( ld, LDAP_OPT_SERVER_CONTROLS, ctrls );
780 if( err != LDAP_OPT_SUCCESS ) {
781 fprintf( stderr, "Could not set %scontrols\n",
782 crit ? "critical " : "" );
791 rc = domodrdn( ld, entrydn, rdn, newSuperior, remove );
792 else while ((rc == 0 || contoper) && fgets(buf, sizeof(buf), fp) != NULL) {
793 if ( *buf != '\0' ) { /* blank lines optional, skip */
794 buf[ strlen( buf ) - 1 ] = '\0'; /* remove nl */
796 if ( havedn ) { /* have DN, get RDN */
797 if (( rdn = strdup( buf )) == NULL ) {
799 return( EXIT_FAILURE );
801 rc = domodrdn(ld, entrydn, rdn, newSuperior, remove );
803 } else if ( !havedn ) { /* don't have DN yet */
804 if (( entrydn = strdup( buf )) == NULL ) {
806 return( EXIT_FAILURE );
824 int remove ) /* flag: remove old RDN */
827 char *matcheddn=NULL, *text=NULL, **refs=NULL;
831 printf( "Renaming \"%s\"\n", dn );
832 printf( "\tnew rdn=\"%s\" (%s old rdn)\n",
833 rdn, remove ? "delete" : "keep" );
834 if( newSuperior != NULL ) {
835 printf("\tnew parent=\"%s\"\n", newSuperior);
839 if( not ) return LDAP_SUCCESS;
841 rc = ldap_rename( ld, dn, rdn, newSuperior, remove,
844 if ( rc != LDAP_SUCCESS ) {
845 fprintf( stderr, "%s: ldap_rename: %s (%d)\n",
846 prog, ldap_err2string( rc ), rc );
850 rc = ldap_result( ld, LDAP_RES_ANY, LDAP_MSG_ALL, NULL, &res );
852 ldap_perror( ld, "ldapmodrdn: ldap_result" );
856 rc = ldap_parse_result( ld, res, &code, &matcheddn, &text, &refs, NULL, 1 );
858 if( rc != LDAP_SUCCESS ) {
859 fprintf( stderr, "%s: ldap_parse_result: %s (%d)\n",
860 prog, ldap_err2string( rc ), rc );
864 if( verbose || code != LDAP_SUCCESS ||
865 (matcheddn && *matcheddn) || (text && *text) || (refs && *refs) )
867 printf( "Rename Result: %s (%d)\n",
868 ldap_err2string( code ), code );
870 if( text && *text ) {
871 printf( "Additional info: %s\n", text );
874 if( matcheddn && *matcheddn ) {
875 printf( "Matched DN: %s\n", matcheddn );
880 for( i=0; refs[i]; i++ ) {
881 printf("Referral: %s\n", refs[i] );
887 ber_memfree( matcheddn );
888 ber_memvfree( (void **) refs );