1 /* ldapdelete.c - simple program to delete an entry using LDAP */
4 * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
12 #include <ac/stdlib.h>
15 #include <ac/signal.h>
16 #include <ac/string.h>
17 #include <ac/unistd.h>
21 #include "lutil_ldap.h"
22 #include "ldap_defaults.h"
25 static char *binddn = NULL;
26 static struct berval passwd = { 0, NULL };
27 static char *ldapuri = NULL;
28 static char *ldaphost = NULL;
29 static int ldapport = 0;
31 #ifdef HAVE_CYRUS_SASL
32 static unsigned sasl_flags = LDAP_SASL_AUTOMATIC;
33 static char *sasl_mech = NULL;
34 static char *sasl_realm = NULL;
35 static char *sasl_authc_id = NULL;
36 static char *sasl_authz_id = NULL;
37 static char *sasl_secprops = NULL;
39 static int use_tls = 0;
40 static int not, verbose, contoper;
41 static LDAP *ld = NULL;
43 static int dodelete LDAP_P((
47 static int deletechildren LDAP_P((
52 usage( const char *s )
55 "Delete entries from an LDAP server\n\n"
56 "usage: %s [options] [dn]...\n"
57 " dn: list of DNs to delete. If not given, it will be readed from stdin\n"
58 " or from the file specified with \"-f file\".\n"
60 " -r delete recursively\n"
63 " -d level set LDAP debugging level to `level'\n"
64 " -D binddn bind DN\n"
65 " -e [!]<ctrl>[=<ctrlparam>] general controls (! indicates criticality)\n"
66 " [!]manageDSAit (alternate form, see -M)\n"
68 " -f file read operations from `file'\n"
69 " -h host LDAP server\n"
70 " -H URI LDAP Uniform Resource Indentifier(s)\n"
71 " -I use SASL Interactive mode\n"
72 " -k use Kerberos authentication\n"
73 " -K like -k, but do only step 1 of the Kerberos bind\n"
74 " -M enable Manage DSA IT control (-MM to make critical)\n"
75 " -n show what would be done but don't actually do it\n"
76 " -O props SASL security properties\n"
77 " -p port port on LDAP server\n"
78 " -P version procotol version (default: 3)\n"
79 " -Q use SASL Quiet mode\n"
80 " -R realm SASL realm\n"
81 " -U authcid SASL authentication identity\n"
82 " -v run in verbose mode (diagnostics to standard output)\n"
83 " -w passwd bind passwd (for simple authentication)\n"
84 " -W prompt for bind passwd\n"
85 " -x Simple authentication\n"
86 " -X authzid SASL authorization identity (\"dn:<dn>\" or \"u:<user>\")\n"
87 " -y file Read passwd from file\n"
88 " -Y mech SASL mechanism\n"
89 " -Z Start TLS request (-ZZ to require successful response)\n"
97 main( int argc, char **argv )
101 int i, rc, authmethod, referrals, want_bindpw, version, debug, manageDSAit, noop, crit;
103 char *control, *cvalue;
105 not = verbose = contoper = want_bindpw = debug
106 = manageDSAit = noop = referrals = 0;
112 prog = lutil_progname( "ldapdelete", argc, argv );
114 while (( i = getopt( argc, argv, "cf:r"
115 "Cd:D:e:h:H:IkKMnO:p:P:QR:U:vw:WxX:y:Y:Z" )) != EOF )
118 /* Delete Specific Options */
119 case 'c': /* continuous operation mode */
122 case 'E': /* delete controls */
123 if( version == LDAP_VERSION2 ) {
124 fprintf( stderr, "%s: -E incompatible with LDAPv%d\n",
129 /* should be extended to support comma separated list of
130 * [!]key[=value] parameters, e.g. -E !foo,bar=567
135 if( optarg[0] == '!' ) {
140 control = strdup( optarg );
141 if ( (cvalue = strchr( control, '=' )) != NULL ) {
144 fprintf( stderr, "Invalid delete control name: %s\n", control );
147 case 'f': /* read DNs from a file */
149 fprintf( stderr, "%s: -f previously specified\n", prog );
152 if (( fp = fopen( optarg, "r" )) == NULL ) {
154 exit( EXIT_FAILURE );
166 debug |= atoi( optarg );
168 case 'D': /* bind DN */
169 if( binddn != NULL ) {
170 fprintf( stderr, "%s: -D previously specified\n", prog );
173 binddn = strdup( optarg );
175 case 'e': /* general controls */
176 if( version == LDAP_VERSION2 ) {
177 fprintf( stderr, "%s: -e incompatible with LDAPv%d\n",
182 /* should be extended to support comma separated list of
183 * [!]key[=value] parameters, e.g. -e !foo,bar=567
188 if( optarg[0] == '!' ) {
193 control = strdup( optarg );
194 if ( (cvalue = strchr( control, '=' )) != NULL ) {
198 if ( strcasecmp( control, "manageDSAit" ) == 0 ) {
199 if( cvalue != NULL ) {
200 fprintf( stderr, "manageDSAit: no control value expected" );
205 manageDSAit = 1 + crit;
209 } else if ( strcasecmp( control, "noop" ) == 0 ) {
210 if( cvalue != NULL ) {
211 fprintf( stderr, "noop: no control value expected" );
221 fprintf( stderr, "Invalid general control name: %s\n", control );
225 case 'h': /* ldap host */
226 if( ldapuri != NULL ) {
227 fprintf( stderr, "%s: -h incompatible with -H\n", prog );
230 if( ldaphost != NULL ) {
231 fprintf( stderr, "%s: -h previously specified\n", prog );
234 ldaphost = strdup( optarg );
236 case 'H': /* ldap URI */
237 if( ldaphost != NULL ) {
238 fprintf( stderr, "%s: -H incompatible with -h\n", prog );
242 fprintf( stderr, "%s: -H incompatible with -p\n", prog );
245 if( ldapuri != NULL ) {
246 fprintf( stderr, "%s: -H previously specified\n", prog );
249 ldapuri = strdup( optarg );
252 #ifdef HAVE_CYRUS_SASL
253 if( version == LDAP_VERSION2 ) {
254 fprintf( stderr, "%s: -I incompatible with version %d\n",
258 if( authmethod != -1 && authmethod != LDAP_AUTH_SASL ) {
259 fprintf( stderr, "%s: incompatible previous "
260 "authentication choice\n",
264 authmethod = LDAP_AUTH_SASL;
265 version = LDAP_VERSION3;
266 sasl_flags = LDAP_SASL_INTERACTIVE;
269 fprintf( stderr, "%s: was not compiled with SASL support\n",
271 return( EXIT_FAILURE );
273 case 'k': /* kerberos bind */
274 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
275 if( version > LDAP_VERSION2 ) {
276 fprintf( stderr, "%s: -k incompatible with LDAPv%d\n",
281 if( authmethod != -1 ) {
282 fprintf( stderr, "%s: -k incompatible with previous "
283 "authentication choice\n", prog );
287 authmethod = LDAP_AUTH_KRBV4;
289 fprintf( stderr, "%s: not compiled with Kerberos support\n", prog );
293 case 'K': /* kerberos bind, part one only */
294 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
295 if( version > LDAP_VERSION2 ) {
296 fprintf( stderr, "%s: -k incompatible with LDAPv%d\n",
300 if( authmethod != -1 ) {
301 fprintf( stderr, "%s: incompatible with previous "
302 "authentication choice\n", prog );
306 authmethod = LDAP_AUTH_KRBV41;
308 fprintf( stderr, "%s: not compiled with Kerberos support\n", prog );
309 return( EXIT_FAILURE );
313 /* enable Manage DSA IT */
314 if( version == LDAP_VERSION2 ) {
315 fprintf( stderr, "%s: -M incompatible with LDAPv%d\n",
320 version = LDAP_VERSION3;
322 case 'n': /* print deletes, don't actually do them */
326 #ifdef HAVE_CYRUS_SASL
327 if( sasl_secprops != NULL ) {
328 fprintf( stderr, "%s: -O previously specified\n", prog );
331 if( version == LDAP_VERSION2 ) {
332 fprintf( stderr, "%s: -O incompatible with LDAPv%d\n",
336 if( authmethod != -1 && authmethod != LDAP_AUTH_SASL ) {
337 fprintf( stderr, "%s: incompatible previous "
338 "authentication choice\n", prog );
341 authmethod = LDAP_AUTH_SASL;
342 version = LDAP_VERSION3;
343 sasl_secprops = strdup( optarg );
345 fprintf( stderr, "%s: not compiled with SASL support\n",
347 return( EXIT_FAILURE );
352 fprintf( stderr, "%s: -p previously specified\n", prog );
355 ldapport = atoi( optarg );
358 switch( atoi(optarg) ) {
360 if( version == LDAP_VERSION3 ) {
361 fprintf( stderr, "%s: -P 2 incompatible with version %d\n",
365 version = LDAP_VERSION2;
368 if( version == LDAP_VERSION2 ) {
369 fprintf( stderr, "%s: -P 2 incompatible with version %d\n",
373 version = LDAP_VERSION3;
376 fprintf( stderr, "%s: protocol version should be 2 or 3\n",
379 return( EXIT_FAILURE );
382 #ifdef HAVE_CYRUS_SASL
383 if( version == LDAP_VERSION2 ) {
384 fprintf( stderr, "%s: -Q incompatible with version %d\n",
388 if( authmethod != -1 && authmethod != LDAP_AUTH_SASL ) {
389 fprintf( stderr, "%s: incompatible previous "
390 "authentication choice\n",
394 authmethod = LDAP_AUTH_SASL;
395 version = LDAP_VERSION3;
396 sasl_flags = LDAP_SASL_QUIET;
399 fprintf( stderr, "%s: not compiled with SASL support\n",
401 return( EXIT_FAILURE );
404 #ifdef HAVE_CYRUS_SASL
405 if( sasl_realm != NULL ) {
406 fprintf( stderr, "%s: -R previously specified\n", prog );
409 if( version == LDAP_VERSION2 ) {
410 fprintf( stderr, "%s: -R incompatible with version %d\n",
414 if( authmethod != -1 && authmethod != LDAP_AUTH_SASL ) {
415 fprintf( stderr, "%s: incompatible previous "
416 "authentication choice\n",
420 authmethod = LDAP_AUTH_SASL;
421 version = LDAP_VERSION3;
422 sasl_realm = strdup( optarg );
424 fprintf( stderr, "%s: not compiled with SASL support\n",
426 return( EXIT_FAILURE );
430 #ifdef HAVE_CYRUS_SASL
431 if( sasl_authc_id != NULL ) {
432 fprintf( stderr, "%s: -U previously specified\n", prog );
435 if( version == LDAP_VERSION2 ) {
436 fprintf( stderr, "%s: -U incompatible with version %d\n",
440 if( authmethod != -1 && authmethod != LDAP_AUTH_SASL ) {
441 fprintf( stderr, "%s: incompatible previous "
442 "authentication choice\n",
446 authmethod = LDAP_AUTH_SASL;
447 version = LDAP_VERSION3;
448 sasl_authc_id = strdup( optarg );
450 fprintf( stderr, "%s: not compiled with SASL support\n",
452 return( EXIT_FAILURE );
455 case 'v': /* verbose mode */
458 case 'w': /* password */
459 passwd.bv_val = strdup( optarg );
463 for( p = optarg; *p != '\0'; p++ ) {
467 passwd.bv_len = strlen( passwd.bv_val );
476 #ifdef HAVE_CYRUS_SASL
477 if( sasl_mech != NULL ) {
478 fprintf( stderr, "%s: -Y previously specified\n", prog );
481 if( version == LDAP_VERSION2 ) {
482 fprintf( stderr, "%s: -Y incompatible with version %d\n",
486 if( authmethod != -1 && authmethod != LDAP_AUTH_SASL ) {
487 fprintf( stderr, "%s: incompatible with authentication choice\n", prog );
490 authmethod = LDAP_AUTH_SASL;
491 version = LDAP_VERSION3;
492 sasl_mech = strdup( optarg );
494 fprintf( stderr, "%s: not compiled with SASL support\n",
496 return( EXIT_FAILURE );
500 if( authmethod != -1 && authmethod != LDAP_AUTH_SIMPLE ) {
501 fprintf( stderr, "%s: incompatible with previous "
502 "authentication choice\n", prog );
505 authmethod = LDAP_AUTH_SIMPLE;
508 #ifdef HAVE_CYRUS_SASL
509 if( sasl_authz_id != NULL ) {
510 fprintf( stderr, "%s: -X previously specified\n", prog );
513 if( version == LDAP_VERSION2 ) {
514 fprintf( stderr, "%s: -X incompatible with LDAPv%d\n",
518 if( authmethod != -1 && authmethod != LDAP_AUTH_SASL ) {
519 fprintf( stderr, "%s: -X incompatible with "
520 "authentication choice\n", prog );
523 authmethod = LDAP_AUTH_SASL;
524 version = LDAP_VERSION3;
525 sasl_authz_id = strdup( optarg );
527 fprintf( stderr, "%s: not compiled with SASL support\n",
529 return( EXIT_FAILURE );
534 if( version == LDAP_VERSION2 ) {
535 fprintf( stderr, "%s: -Z incompatible with version %d\n",
539 version = LDAP_VERSION3;
542 fprintf( stderr, "%s: not compiled with TLS support\n",
544 return( EXIT_FAILURE );
548 fprintf( stderr, "%s: unrecognized option -%c\n",
551 return( EXIT_FAILURE );
556 version = LDAP_VERSION3;
558 if (authmethod == -1 && version > LDAP_VERSION2) {
559 #ifdef HAVE_CYRUS_SASL
560 authmethod = LDAP_AUTH_SASL;
562 authmethod = LDAP_AUTH_SIMPLE;
567 if ( optind >= argc ) {
573 if( ber_set_option( NULL, LBER_OPT_DEBUG_LEVEL, &debug ) != LBER_OPT_SUCCESS ) {
574 fprintf( stderr, "Could not set LBER_OPT_DEBUG_LEVEL %d\n", debug );
576 if( ldap_set_option( NULL, LDAP_OPT_DEBUG_LEVEL, &debug ) != LDAP_OPT_SUCCESS ) {
577 fprintf( stderr, "Could not set LDAP_OPT_DEBUG_LEVEL %d\n", debug );
582 (void) SIGNAL( SIGPIPE, SIG_IGN );
585 if( ( ldaphost != NULL || ldapport ) && ( ldapuri == NULL ) ) {
587 fprintf( stderr, "ldap_init( %s, %d )\n",
588 ldaphost != NULL ? ldaphost : "<DEFAULT>",
592 ld = ldap_init( ldaphost, ldapport );
594 perror("ldapdelete: ldap_init");
600 fprintf( stderr, "ldap_initialize( %s )\n",
601 ldapuri != NULL ? ldapuri : "<DEFAULT>" );
604 rc = ldap_initialize( &ld, ldapuri );
605 if( rc != LDAP_SUCCESS ) {
606 fprintf( stderr, "Could not create LDAP session handle (%d): %s\n",
607 rc, ldap_err2string(rc) );
613 /* this seems prudent for searches below */
614 int deref = LDAP_DEREF_NEVER;
615 ldap_set_option( ld, LDAP_OPT_DEREF, &deref );
618 /* chase referrals */
619 if( ldap_set_option( ld, LDAP_OPT_REFERRALS,
620 referrals ? LDAP_OPT_ON : LDAP_OPT_OFF ) != LDAP_OPT_SUCCESS )
622 fprintf( stderr, "Could not set LDAP_OPT_REFERRALS %s\n",
623 referrals ? "on" : "off" );
627 if( ldap_set_option( ld, LDAP_OPT_PROTOCOL_VERSION, &version )
628 != LDAP_OPT_SUCCESS )
630 fprintf( stderr, "Could not set LDAP_OPT_PROTOCOL_VERSION %d\n",
635 if ( use_tls && ( ldap_start_tls_s( ld, NULL, NULL ) != LDAP_SUCCESS )) {
636 ldap_perror( ld, "ldap_start_tls" );
642 if ( pw_file || want_bindpw ) {
644 rc = lutil_get_filed_password( pw_file, &passwd );
645 if( rc ) return EXIT_FAILURE;
647 passwd.bv_val = getpassphrase( "Enter LDAP Password: " );
648 passwd.bv_len = passwd.bv_val ? strlen( passwd.bv_val ) : 0;
652 if ( authmethod == LDAP_AUTH_SASL ) {
653 #ifdef HAVE_CYRUS_SASL
656 if( sasl_secprops != NULL ) {
657 rc = ldap_set_option( ld, LDAP_OPT_X_SASL_SECPROPS,
658 (void *) sasl_secprops );
660 if( rc != LDAP_OPT_SUCCESS ) {
662 "Could not set LDAP_OPT_X_SASL_SECPROPS: %s\n",
664 return( EXIT_FAILURE );
668 defaults = lutil_sasl_defaults( ld,
675 rc = ldap_sasl_interactive_bind_s( ld, binddn,
676 sasl_mech, NULL, NULL,
677 sasl_flags, lutil_sasl_interact, defaults );
679 if( rc != LDAP_SUCCESS ) {
680 ldap_perror( ld, "ldap_sasl_interactive_bind_s" );
681 return( EXIT_FAILURE );
684 fprintf( stderr, "%s: not compiled with SASL support\n",
686 return( EXIT_FAILURE );
690 if ( ldap_bind_s( ld, binddn, passwd.bv_val, authmethod )
692 ldap_perror( ld, "ldap_bind" );
693 return( EXIT_FAILURE );
697 if ( manageDSAit || noop ) {
700 LDAPControl *ctrls[3];
705 c1.ldctl_oid = LDAP_CONTROL_MANAGEDSAIT;
706 c1.ldctl_value.bv_val = NULL;
707 c1.ldctl_value.bv_len = 0;
708 c1.ldctl_iscritical = manageDSAit > 1;
715 c2.ldctl_oid = LDAP_CONTROL_NOOP;
716 c2.ldctl_value.bv_val = NULL;
717 c2.ldctl_value.bv_len = 0;
718 c2.ldctl_iscritical = noop > 1;
721 err = ldap_set_option( ld, LDAP_OPT_SERVER_CONTROLS, ctrls );
723 if( err != LDAP_OPT_SUCCESS ) {
724 fprintf( stderr, "Could not set %scontrols\n",
725 (c1.ldctl_iscritical || c2.ldctl_iscritical)
726 ? "critical " : "" );
727 if ( c1.ldctl_iscritical && c2.ldctl_iscritical ) {
736 for ( ; optind < argc; ++optind ) {
737 rc = dodelete( ld, argv[ optind ] );
739 /* Stop on error and no -c option */
740 if( rc != 0 && contoper == 0) break;
743 while ((rc == 0 || contoper) && fgets(buf, sizeof(buf), fp) != NULL) {
744 buf[ strlen( buf ) - 1 ] = '\0'; /* remove trailing newline */
746 if ( *buf != '\0' ) {
747 rc = dodelete( ld, buf );
764 char *matcheddn = NULL, *text = NULL, **refs = NULL;
768 printf( "%sdeleting entry \"%s\"\n",
769 (not ? "!" : ""), dn );
776 /* If prune is on, remove a whole subtree. Delete the children of the
777 * DN recursively, then the DN requested.
779 if ( prune ) deletechildren( ld, dn );
781 rc = ldap_delete_ext( ld, dn, NULL, NULL, &id );
782 if ( rc != LDAP_SUCCESS ) {
783 fprintf( stderr, "%s: ldap_delete_ext: %s (%d)\n",
784 prog, ldap_err2string( rc ), rc );
788 rc = ldap_result( ld, LDAP_RES_ANY, LDAP_MSG_ALL, NULL, &res );
790 ldap_perror( ld, "ldapdelete: ldap_result" );
794 rc = ldap_parse_result( ld, res, &code, &matcheddn, &text, &refs, NULL, 1 );
796 if( rc != LDAP_SUCCESS ) {
797 fprintf( stderr, "%s: ldap_parse_result: %s (%d)\n",
798 prog, ldap_err2string( rc ), rc );
802 if( verbose || code != LDAP_SUCCESS ||
803 (matcheddn && *matcheddn) || (text && *text) || (refs && *refs) )
805 printf( "Delete Result: %s (%d)\n", ldap_err2string( code ), code );
807 if( text && *text ) {
808 printf( "Additional info: %s\n", text );
811 if( matcheddn && *matcheddn ) {
812 printf( "Matched DN: %s\n", matcheddn );
817 for( i=0; refs[i]; i++ ) {
818 printf("Referral: %s\n", refs[i] );
824 ber_memfree( matcheddn );
825 ber_memvfree( (void **) refs );
831 * Delete all the children of an entry recursively until leaf nodes are reached.
834 static int deletechildren(
838 LDAPMessage *res, *e;
841 static char *attrs[] = { "1.1", NULL };
843 if ( verbose ) printf ( "deleting children of: %s\n", dn );
845 * Do a one level search at dn for children. For each, delete its children.
848 rc = ldap_search_ext_s( ld, dn, LDAP_SCOPE_ONELEVEL, NULL, attrs, 1,
849 NULL, NULL, NULL, -1, &res );
850 if ( rc != LDAP_SUCCESS ) {
851 ldap_perror( ld, "ldap_search" );
855 entries = ldap_count_entries( ld, res );
860 for (e = ldap_first_entry( ld, res ), i = 0; e != NULL;
861 e = ldap_next_entry( ld, e ), i++ )
863 char *dn = ldap_get_dn( ld, e );
866 ldap_perror( ld, "ldap_prune" );
867 ldap_get_option( ld, LDAP_OPT_ERROR_NUMBER, &rc );
872 rc = deletechildren( ld, dn );
874 ldap_perror( ld, "ldap_prune" );
880 printf( "\tremoving %s\n", dn );
883 rc = ldap_delete_s( ld, dn );
885 ldap_perror( ld, "ldap_delete" );
892 printf( "\t%s removed\n", dn );