git.sur5r.net Git - openldap/blob - clients/tools/ldapdelete.c

   1 /* ldapdelete.c - simple program to delete an entry using LDAP */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 1998-2006 The OpenLDAP Foundation.
   6  * Portions Copyright 1998-2003 Kurt D. Zeilenga.
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted only as authorized by the OpenLDAP
  11  * Public License.
  12  *
  13  * A copy of this license is available in the file LICENSE in the
  14  * top-level directory of the distribution or, alternatively, at
  15  * <http://www.OpenLDAP.org/license.html>.
  16  */
  17 /* Portions Copyright (c) 1992-1996 Regents of the University of Michigan.
  18  * All rights reserved.
  19  *
  20  * Redistribution and use in source and binary forms are permitted
  21  * provided that this notice is preserved and that due credit is given
  22  * to the University of Michigan at Ann Arbor.  The name of the
  23  * University may not be used to endorse or promote products derived
  24  * from this software without specific prior written permission.  This
  25  * software is provided ``as is'' without express or implied warranty.
  26  */
  27 /* ACKNOWLEDGEMENTS:
  28  * This work was originally developed by the University of Michigan
  29  * (as part of U-MICH LDAP).  Additional significant contributors
  30  * include:
  31  *   Kurt D. Zeilenga
  32  */
  33
  34 #include "portable.h"
  35
  36 #include <stdio.h>
  37
  38 #include <ac/stdlib.h>
  39 #include <ac/ctype.h>
  40 #include <ac/string.h>
  41 #include <ac/unistd.h>
  42 #include <ac/time.h>
  43
  44 #include <ldap.h>
  45 #include "lutil.h"
  46 #include "lutil_ldap.h"
  47 #include "ldap_defaults.h"
  48
  49 #include "common.h"
  50
  51
  52 static int      prune = 0;
  53
  54
  55 static int dodelete LDAP_P((
  56     LDAP *ld,
  57     const char *dn));
  58
  59 static int deletechildren LDAP_P((
  60         LDAP *ld,
  61         const char *dn ));
  62
  63 void
  64 usage( void )
  65 {
  66         fprintf( stderr, _("Delete entries from an LDAP server\n\n"));
  67         fprintf( stderr, _("usage: %s [options] [dn]...\n"), prog);
  68         fprintf( stderr, _("    dn: list of DNs to delete. If not given, it will be readed from stdin\n"));
  69         fprintf( stderr, _("        or from the file specified with \"-f file\".\n"));
  70         fprintf( stderr, _("Delete Options:\n"));
  71         fprintf( stderr, _("  -r         delete recursively\n"));
  72         tool_common_usage();
  73         exit( EXIT_FAILURE );
  74 }
  75
  76
  77 const char options[] = "r"
  78         "cd:D:e:f:h:H:IkKMnO:p:P:QR:U:vVw:WxX:y:Y:Z";
  79
  80 int
  81 handle_private_option( int i )
  82 {
  83         switch ( i ) {
  84 #if 0
  85                 int crit;
  86                 char *control, *cvalue;
  87         case 'E': /* delete extensions */
  88                 if( protocol == LDAP_VERSION2 ) {
  89                         fprintf( stderr, _("%s: -E incompatible with LDAPv%d\n"),
  90                                 prog, protocol );
  91                         exit( EXIT_FAILURE );
  92                 }
  93
  94                 /* should be extended to support comma separated list of
  95                  *      [!]key[=value] parameters, e.g.  -E !foo,bar=567
  96                  */
  97
  98                 crit = 0;
  99                 cvalue = NULL;
 100                 if( optarg[0] == '!' ) {
 101                         crit = 1;
 102                         optarg++;
 103                 }
 104
 105                 control = strdup( optarg );
 106                 if ( (cvalue = strchr( control, '=' )) != NULL ) {
 107                         *cvalue++ = '\0';
 108                 }
 109                 fprintf( stderr, _("Invalid delete extension name: %s\n"), control );
 110                 usage();
 111 #endif
 112
 113         case 'r':
 114                 prune = 1;
 115                 break;
 116
 117         default:
 118                 return 0;
 119         }
 120         return 1;
 121 }
 122
 123
 124 static void
 125 private_conn_setup( LDAP *ld )
 126 {
 127         /* this seems prudent for searches below */
 128         int deref = LDAP_DEREF_NEVER;
 129         ldap_set_option( ld, LDAP_OPT_DEREF, &deref );
 130 }
 131
 132
 133 int
 134 main( int argc, char **argv )
 135 {
 136         char            buf[ 4096 ];
 137         FILE            *fp;
 138         LDAP            *ld;
 139         int             rc, retval;
 140
 141     fp = NULL;
 142
 143         tool_init( TOOL_DELETE );
 144     prog = lutil_progname( "ldapdelete", argc, argv );
 145
 146         tool_args( argc, argv );
 147
 148         if ( infile != NULL ) {
 149                 if (( fp = fopen( infile, "r" )) == NULL ) {
 150                         perror( optarg );
 151                         exit( EXIT_FAILURE );
 152             }
 153         } else {
 154         if ( optind >= argc ) {
 155             fp = stdin;
 156         }
 157     }
 158
 159         ld = tool_conn_setup( 0, &private_conn_setup );
 160
 161         if ( pw_file || want_bindpw ) {
 162                 if ( pw_file ) {
 163                         rc = lutil_get_filed_password( pw_file, &passwd );
 164                         if( rc ) return EXIT_FAILURE;
 165                 } else {
 166                         passwd.bv_val = getpassphrase( _("Enter LDAP Password: ") );
 167                         passwd.bv_len = passwd.bv_val ? strlen( passwd.bv_val ) : 0;
 168                 }
 169         }
 170
 171         tool_bind( ld );
 172
 173         tool_server_controls( ld, NULL, 0 );
 174
 175         retval = rc = 0;
 176
 177         if ( fp == NULL ) {
 178                 for ( ; optind < argc; ++optind ) {
 179                         rc = dodelete( ld, argv[ optind ] );
 180
 181                         /* Stop on error and no -c option */
 182                         if( rc != 0 ) {
 183                                 retval = rc;
 184                                 if( contoper == 0 ) break;
 185                         }
 186                 }
 187         } else {
 188                 while ((rc == 0 || contoper) && fgets(buf, sizeof(buf), fp) != NULL) {
 189                         buf[ strlen( buf ) - 1 ] = '\0'; /* remove trailing newline */
 190
 191                         if ( *buf != '\0' ) {
 192                                 rc = dodelete( ld, buf );
 193                                 if ( rc != 0 )
 194                                         retval = rc;
 195                         }
 196                 }
 197         }
 198
 199         tool_unbind( ld );
 200         tool_destroy();
 201     return retval;
 202 }
 203
 204
 205 static int dodelete(
 206     LDAP        *ld,
 207     const char  *dn)
 208 {
 209         int id;
 210         int     rc, code;
 211         char *matcheddn = NULL, *text = NULL, **refs = NULL;
 212         LDAPMessage *res;
 213
 214         if ( verbose ) {
 215                 printf( _("%sdeleting entry \"%s\"\n"),
 216                         (dont ? "!" : ""), dn );
 217         }
 218
 219         if ( dont ) {
 220                 return LDAP_SUCCESS;
 221         }
 222
 223         /* If prune is on, remove a whole subtree.  Delete the children of the
 224          * DN recursively, then the DN requested.
 225          */
 226         if ( prune ) deletechildren( ld, dn );
 227
 228         rc = ldap_delete_ext( ld, dn, NULL, NULL, &id );
 229         if ( rc != LDAP_SUCCESS ) {
 230                 fprintf( stderr, "%s: ldap_delete_ext: %s (%d)\n",
 231                         prog, ldap_err2string( rc ), rc );
 232                 return rc;
 233         }
 234
 235         for ( ; ; ) {
 236                 struct timeval tv;
 237
 238                 if ( tool_check_abandon( ld, id ) ) {
 239                         return LDAP_CANCELLED;
 240                 }
 241
 242                 tv.tv_sec = 0;
 243                 tv.tv_usec = 100000;
 244
 245                 rc = ldap_result( ld, LDAP_RES_ANY, LDAP_MSG_ALL, &tv, &res );
 246                 if ( rc < 0 ) {
 247                         tool_perror( "ldap_result", rc, NULL, NULL, NULL, NULL );
 248                         return rc;
 249                 }
 250
 251                 if ( rc != 0 ) {
 252                         break;
 253                 }
 254         }
 255
 256         rc = ldap_parse_result( ld, res, &code, &matcheddn, &text, &refs, NULL, 1 );
 257
 258         if( rc != LDAP_SUCCESS ) {
 259                 fprintf( stderr, "%s: ldap_parse_result: %s (%d)\n",
 260                         prog, ldap_err2string( rc ), rc );
 261                 return rc;
 262         }
 263
 264         if( verbose || code != LDAP_SUCCESS ||
 265                 (matcheddn && *matcheddn) || (text && *text) || (refs && *refs) )
 266         {
 267                 printf( _("Delete Result: %s (%d)\n"),
 268                         ldap_err2string( code ), code );
 269
 270                 if( text && *text ) {
 271                         printf( _("Additional info: %s\n"), text );
 272                 }
 273
 274                 if( matcheddn && *matcheddn ) {
 275                         printf( _("Matched DN: %s\n"), matcheddn );
 276                 }
 277
 278                 if( refs ) {
 279                         int i;
 280                         for( i=0; refs[i]; i++ ) {
 281                                 printf(_("Referral: %s\n"), refs[i] );
 282                         }
 283                 }
 284         }
 285
 286         ber_memfree( text );
 287         ber_memfree( matcheddn );
 288         ber_memvfree( (void **) refs );
 289
 290         return code;
 291 }
 292
 293 /*
 294  * Delete all the children of an entry recursively until leaf nodes are reached.
 295  */
 296 static int deletechildren(
 297         LDAP *ld,
 298         const char *dn )
 299 {
 300         LDAPMessage *res, *e;
 301         int entries;
 302         int rc;
 303         static char *attrs[] = { LDAP_NO_ATTRS, NULL };
 304         LDAPControl c, *ctrls[2];
 305         BerElement *ber = NULL;
 306         LDAPMessage *res_se;
 307
 308         if ( verbose ) printf ( _("deleting children of: %s\n"), dn );
 309
 310         /*
 311          * Do a one level search at dn for children.  For each, delete its children.
 312          */
 313
 314         rc = ldap_search_ext_s( ld, dn, LDAP_SCOPE_ONELEVEL, NULL, attrs, 1,
 315                 NULL, NULL, NULL, -1, &res );
 316         if ( rc != LDAP_SUCCESS ) {
 317                 tool_perror( "ldap_search", rc, NULL, NULL, NULL, NULL );
 318                 return( rc );
 319         }
 320
 321         entries = ldap_count_entries( ld, res );
 322
 323         if ( entries > 0 ) {
 324                 int i;
 325
 326                 for (e = ldap_first_entry( ld, res ), i = 0; e != NULL;
 327                         e = ldap_next_entry( ld, e ), i++ )
 328                 {
 329                         char *dn = ldap_get_dn( ld, e );
 330
 331                         if( dn == NULL ) {
 332                                 ldap_get_option( ld, LDAP_OPT_ERROR_NUMBER, &rc );
 333                                 tool_perror( "ldap_prune", rc, NULL, NULL, NULL, NULL );
 334                                 ber_memfree( dn );
 335                                 return rc;
 336                         }
 337
 338                         rc = deletechildren( ld, dn );
 339                         if ( rc == -1 ) {
 340                                 tool_perror( "ldap_prune", rc, NULL, NULL, NULL, NULL );
 341                                 ber_memfree( dn );
 342                                 return rc;
 343                         }
 344
 345                         if ( verbose ) {
 346                                 printf( _("\tremoving %s\n"), dn );
 347                         }
 348
 349                         rc = ldap_delete_ext_s( ld, dn, NULL, NULL );
 350                         if ( rc == -1 ) {
 351                                 tool_perror( "ldap_delete", rc, NULL, NULL, NULL, NULL );
 352                                 ber_memfree( dn );
 353                                 return rc;
 354
 355                         }
 356
 357                         if ( verbose ) {
 358                                 printf( _("\t%s removed\n"), dn );
 359                         }
 360
 361                         ber_memfree( dn );
 362                 }
 363         }
 364
 365         ldap_msgfree( res );
 366
 367         /*
 368          * Do a one level search at dn for subentry children.
 369          */
 370
 371         if ((ber = ber_alloc_t(LBER_USE_DER)) == NULL) {
 372                 return EXIT_FAILURE;
 373         }
 374         rc = ber_printf( ber, "b", 1 );
 375         if ( rc == -1 ) {
 376                 ber_free( ber, 1 );
 377                 fprintf( stderr, _("Subentries control encoding error!\n"));
 378                 return EXIT_FAILURE;
 379         }
 380         if ( ber_flatten2( ber, &c.ldctl_value, 0 ) == -1 ) {
 381                 return EXIT_FAILURE;
 382         }
 383         c.ldctl_oid = LDAP_CONTROL_SUBENTRIES;
 384         c.ldctl_iscritical = 1;
 385         ctrls[0] = &c;
 386         ctrls[1] = NULL;
 387
 388         rc = ldap_search_ext_s( ld, dn, LDAP_SCOPE_ONELEVEL, NULL, attrs, 1,
 389                 ctrls, NULL, NULL, -1, &res_se );
 390         if ( rc != LDAP_SUCCESS ) {
 391                 tool_perror( "ldap_search", rc, NULL, NULL, NULL, NULL );
 392                 return( rc );
 393         }
 394         ber_free( ber, 1 );
 395
 396         entries = ldap_count_entries( ld, res_se );
 397
 398         if ( entries > 0 ) {
 399                 int i;
 400
 401                 for (e = ldap_first_entry( ld, res_se ), i = 0; e != NULL;
 402                         e = ldap_next_entry( ld, e ), i++ )
 403                 {
 404                         char *dn = ldap_get_dn( ld, e );
 405
 406                         if( dn == NULL ) {
 407                                 ldap_get_option( ld, LDAP_OPT_ERROR_NUMBER, &rc );
 408                                 tool_perror( "ldap_prune", rc, NULL, NULL, NULL, NULL );
 409                                 ber_memfree( dn );
 410                                 return rc;
 411                         }
 412
 413                         if ( verbose ) {
 414                                 printf( _("\tremoving %s\n"), dn );
 415                         }
 416
 417                         rc = ldap_delete_ext_s( ld, dn, NULL, NULL );
 418                         if ( rc == -1 ) {
 419                                 tool_perror( "ldap_delete", rc, NULL, NULL, NULL, NULL );
 420                                 ber_memfree( dn );
 421                                 return rc;
 422
 423                         }
 424
 425                         if ( verbose ) {
 426                                 printf( _("\t%s removed\n"), dn );
 427                         }
 428
 429                         ber_memfree( dn );
 430                 }
 431         }
 432
 433         ldap_msgfree( res_se );
 434         return rc;
 435 }