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

   1 #include "portable.h"
   2
   3 #include <stdio.h>
   4 #include <stdlib.h>
   5
   6 #include <ac/ctype.h>
   7 #include <ac/string.h>
   8 #include <ac/unistd.h>
   9
  10 #include <lber.h>
  11 #include <ldap.h>
  12 #include <ldif.h>
  13
  14 #define DEFSEP          "="
  15
  16
  17 static void
  18 usage( char *s )
  19 {
  20     fprintf( stderr, "usage: %s [options] filter [attributes...]\nwhere:\n", s );
  21     fprintf( stderr, "    filter\tRFC-1558 compliant LDAP search filter\n" );
  22     fprintf( stderr, "    attributes\twhitespace-separated list of attributes to retrieve\n" );
  23     fprintf( stderr, "\t\t(if no attribute list is given, all are retrieved)\n" );
  24     fprintf( stderr, "options:\n" );
  25     fprintf( stderr, "    -n\t\tshow what would be done but don't actually search\n" );
  26     fprintf( stderr, "    -v\t\trun in verbose mode (diagnostics to standard output)\n" );
  27     fprintf( stderr, "    -t\t\twrite values to files in /tmp\n" );
  28     fprintf( stderr, "    -u\t\tinclude User Friendly entry names in the output\n" );
  29     fprintf( stderr, "    -A\t\tretrieve attribute names only (no values)\n" );
  30     fprintf( stderr, "    -B\t\tdo not suppress printing of non-ASCII values\n" );
  31     fprintf( stderr, "    -L\t\tprint entries in LDIF format (-B is implied)\n" );
  32 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
  33     fprintf( stderr, "    -R\t\tdo not automatically follow referrals\n" );
  34 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
  35     fprintf( stderr, "    -d level\tset LDAP debugging level to `level'\n" );
  36     fprintf( stderr, "    -F sep\tprint `sep' instead of `=' between attribute names and values\n" );
  37     fprintf( stderr, "    -S attr\tsort the results by attribute `attr'\n" );
  38     fprintf( stderr, "    -f file\tperform sequence of searches listed in `file'\n" );
  39     fprintf( stderr, "    -b basedn\tbase dn for search\n" );
  40     fprintf( stderr, "    -s scope\tone of base, one, or sub (search scope)\n" );
  41     fprintf( stderr, "    -a deref\tone of never, always, search, or find (alias dereferencing)\n" );
  42     fprintf( stderr, "    -l time lim\ttime limit (in seconds) for search\n" );
  43     fprintf( stderr, "    -z size lim\tsize limit (in entries) for search\n" );
  44     fprintf( stderr, "    -D binddn\tbind dn\n" );
  45     fprintf( stderr, "    -w passwd\tbind passwd (for simple authentication)\n" );
  46     fprintf( stderr, "    -W\t\tprompt for bind passwd\n" );
  47 #ifdef HAVE_KERBEROS
  48     fprintf( stderr, "    -k\t\tuse Kerberos instead of Simple Password authentication\n" );
  49 #endif
  50     fprintf( stderr, "    -h host\tldap server\n" );
  51     fprintf( stderr, "    -p port\tport on ldap server\n" );
  52     exit( 1 );
  53 }
  54
  55 static void print_entry LDAP_P((
  56     LDAP        *ld,
  57     LDAPMessage *entry,
  58     int         attrsonly));
  59
  60 static int write_ldif_value LDAP_P((
  61         char *type,
  62         char *value,
  63         unsigned long vallen ));
  64
  65 static int dosearch LDAP_P((
  66         LDAP    *ld,
  67     char        *base,
  68     int         scope,
  69     char        **attrs,
  70     int         attrsonly,
  71     char        *filtpatt,
  72     char        *value));
  73
  74 static char     *binddn = NULL;
  75 static char     *passwd = NULL;
  76 static char     *base = NULL;
  77 static char     *ldaphost = NULL;
  78 static int      ldapport = 0;
  79 static char     *sep = DEFSEP;
  80 static char     *sortattr = NULL;
  81 static int      skipsortattr = 0;
  82 static int      verbose, not, includeufn, allow_binary, vals2tmp, ldif;
  83
  84 int
  85 main( int argc, char **argv )
  86 {
  87     char                *infile, *filtpattern, **attrs, line[ BUFSIZ ];
  88     FILE                *fp;
  89     int                 rc, i, first, scope, deref, attrsonly;
  90     int                 referrals, timelimit, sizelimit, authmethod, want_bindpw;
  91     LDAP                *ld;
  92
  93     infile = NULL;
  94     deref = verbose = allow_binary = not = vals2tmp =
  95             attrsonly = ldif = want_bindpw = 0;
  96     referrals = (int) LDAP_OPT_ON;
  97     sizelimit = timelimit = 0;
  98     scope = LDAP_SCOPE_SUBTREE;
  99     authmethod = LDAP_AUTH_SIMPLE;
 100
 101     while (( i = getopt( argc, argv, "WKknuvtRABLD:s:f:h:b:d:p:F:a:w:l:z:S:")) != EOF ) {
 102         switch( i ) {
 103         case 'n':       /* do Not do any searches */
 104             ++not;
 105             break;
 106         case 'v':       /* verbose mode */
 107             ++verbose;
 108             break;
 109         case 'd':
 110 #ifdef LDAP_DEBUG
 111             ldap_debug = lber_debug = atoi( optarg );   /* */
 112 #else /* LDAP_DEBUG */
 113             fprintf( stderr, "compile with -DLDAP_DEBUG for debugging\n" );
 114 #endif /* LDAP_DEBUG */
 115             break;
 116         case 'k':       /* use kerberos bind */
 117 #ifdef HAVE_KERBEROS
 118                 authmethod = LDAP_AUTH_KRBV4;
 119 #else
 120                 fprintf (stderr, "%s was not compiled with Kerberos support\n", argv[0]);
 121 #endif
 122             break;
 123         case 'K':       /* use kerberos bind, 1st part only */
 124 #ifdef HAVE_KERBEROS
 125                 authmethod = LDAP_AUTH_KRBV41;
 126 #else
 127                 fprintf (stderr, "%s was not compiled with Kerberos support\n", argv[0]);
 128 #endif
 129             break;
 130         case 'u':       /* include UFN */
 131             ++includeufn;
 132             break;
 133         case 't':       /* write attribute values to /tmp files */
 134             ++vals2tmp;
 135             break;
 136         case 'R':       /* don't automatically chase referrals */
 137                 referrals = (int) LDAP_OPT_OFF;
 138             break;
 139         case 'A':       /* retrieve attribute names only -- no values */
 140             ++attrsonly;
 141             break;
 142         case 'L':       /* print entries in LDIF format */
 143             ++ldif;
 144             /* fall through -- always allow binary when outputting LDIF */
 145         case 'B':       /* allow binary values to be printed */
 146             ++allow_binary;
 147             break;
 148         case 's':       /* search scope */
 149             if ( strncasecmp( optarg, "base", 4 ) == 0 ) {
 150                 scope = LDAP_SCOPE_BASE;
 151             } else if ( strncasecmp( optarg, "one", 3 ) == 0 ) {
 152                 scope = LDAP_SCOPE_ONELEVEL;
 153             } else if ( strncasecmp( optarg, "sub", 3 ) == 0 ) {
 154                 scope = LDAP_SCOPE_SUBTREE;
 155             } else {
 156                 fprintf( stderr, "scope should be base, one, or sub\n" );
 157                 usage( argv[ 0 ] );
 158             }
 159             break;
 160
 161         case 'a':       /* set alias deref option */
 162             if ( strncasecmp( optarg, "never", 5 ) == 0 ) {
 163                 deref = LDAP_DEREF_NEVER;
 164             } else if ( strncasecmp( optarg, "search", 5 ) == 0 ) {
 165                 deref = LDAP_DEREF_SEARCHING;
 166             } else if ( strncasecmp( optarg, "find", 4 ) == 0 ) {
 167                 deref = LDAP_DEREF_FINDING;
 168             } else if ( strncasecmp( optarg, "always", 6 ) == 0 ) {
 169                 deref = LDAP_DEREF_ALWAYS;
 170             } else {
 171                 fprintf( stderr, "alias deref should be never, search, find, or always\n" );
 172                 usage( argv[ 0 ] );
 173             }
 174             break;
 175
 176         case 'F':       /* field separator */
 177             sep = strdup( optarg );
 178             break;
 179         case 'f':       /* input file */
 180             infile = strdup( optarg );
 181             break;
 182         case 'h':       /* ldap host */
 183             ldaphost = strdup( optarg );
 184             break;
 185         case 'b':       /* searchbase */
 186             base = strdup( optarg );
 187             break;
 188         case 'D':       /* bind DN */
 189             binddn = strdup( optarg );
 190             break;
 191         case 'p':       /* ldap port */
 192             ldapport = atoi( optarg );
 193             break;
 194         case 'w':       /* bind password */
 195             passwd = strdup( optarg );
 196             break;
 197         case 'l':       /* time limit */
 198             timelimit = atoi( optarg );
 199             break;
 200         case 'z':       /* size limit */
 201             sizelimit = atoi( optarg );
 202             break;
 203         case 'S':       /* sort attribute */
 204             sortattr = strdup( optarg );
 205             break;
 206         case 'W':
 207                 want_bindpw++;
 208                 break;
 209         default:
 210             usage( argv[0] );
 211         }
 212     }
 213
 214     if ( argc - optind < 1 ) {
 215         usage( argv[ 0 ] );
 216     }
 217     filtpattern = strdup( argv[ optind ] );
 218     if ( argv[ optind + 1 ] == NULL ) {
 219         attrs = NULL;
 220     } else if ( sortattr == NULL || *sortattr == '\0' ) {
 221         attrs = &argv[ optind + 1 ];
 222     } else {
 223         for ( i = optind + 1; i < argc; i++ ) {
 224             if ( strcasecmp( argv[ i ], sortattr ) == 0 ) {
 225                 break;
 226             }
 227         }
 228         if ( i == argc ) {
 229                 skipsortattr = 1;
 230                 argv[ optind ] = sortattr;
 231         } else {
 232                 optind++;
 233         }
 234         attrs = &argv[ optind ];
 235     }
 236
 237     if ( infile != NULL ) {
 238         if ( infile[0] == '-' && infile[1] == '\0' ) {
 239             fp = stdin;
 240         } else if (( fp = fopen( infile, "r" )) == NULL ) {
 241             perror( infile );
 242             exit( 1 );
 243         }
 244     }
 245
 246     if ( verbose ) {
 247         printf( "ldap_open( %s, %d )\n", ldaphost, ldapport );
 248     }
 249
 250     if (( ld = ldap_open( ldaphost, ldapport )) == NULL ) {
 251         perror( ldaphost );
 252         exit( 1 );
 253     }
 254
 255         if (ldap_set_option( ld, LDAP_OPT_DEREF, (void *) &deref ) == -1 ) {
 256                 /* set option error */
 257         }
 258         if (ldap_set_option( ld, LDAP_OPT_TIMELIMIT, (void *) &timelimit ) == -1 ) {
 259                 /* set option error */
 260         }
 261         if (ldap_set_option( ld, LDAP_OPT_SIZELIMIT, (void *) &sizelimit ) == -1 ) {
 262                 /* set option error */
 263         }
 264         if (ldap_set_option( ld, LDAP_OPT_REFERRALS, (void *) referrals ) == -1 ) {
 265                 /* set option error */
 266         }
 267
 268         if (want_bindpw)
 269                 passwd = getpass("Enter LDAP Password: ");
 270
 271     if ( ldap_bind_s( ld, binddn, passwd, authmethod ) != LDAP_SUCCESS ) {
 272         ldap_perror( ld, "ldap_bind" );
 273         exit( 1 );
 274     }
 275
 276     if ( verbose ) {
 277         printf( "filter pattern: %s\nreturning: ", filtpattern );
 278         if ( attrs == NULL ) {
 279             printf( "ALL" );
 280         } else {
 281             for ( i = 0; attrs[ i ] != NULL; ++i ) {
 282                 printf( "%s ", attrs[ i ] );
 283             }
 284         }
 285         putchar( '\n' );
 286     }
 287
 288     if ( infile == NULL ) {
 289         rc = dosearch( ld, base, scope, attrs, attrsonly, filtpattern, "" );
 290     } else {
 291         rc = 0;
 292         first = 1;
 293         while ( rc == 0 && fgets( line, sizeof( line ), fp ) != NULL ) {
 294             line[ strlen( line ) - 1 ] = '\0';
 295             if ( !first ) {
 296                 putchar( '\n' );
 297             } else {
 298                 first = 0;
 299             }
 300             rc = dosearch( ld, base, scope, attrs, attrsonly, filtpattern,
 301                     line );
 302         }
 303         if ( fp != stdin ) {
 304             fclose( fp );
 305         }
 306     }
 307
 308     ldap_unbind( ld );
 309     exit( rc );
 310
 311         /* UNREACHABLE */
 312         return(0);
 313 }
 314
 315
 316 static int dosearch(
 317         LDAP    *ld,
 318     char        *base,
 319     int         scope,
 320     char        **attrs,
 321     int         attrsonly,
 322     char        *filtpatt,
 323     char        *value)
 324 {
 325     char                filter[ BUFSIZ ];
 326     int                 rc, first, matches;
 327     LDAPMessage         *res, *e;
 328
 329     sprintf( filter, filtpatt, value );
 330
 331     if ( verbose ) {
 332         printf( "filter is: (%s)\n", filter );
 333     }
 334
 335     if ( not ) {
 336         return( LDAP_SUCCESS );
 337     }
 338
 339     if ( ldap_search( ld, base, scope, filter, attrs, attrsonly ) == -1 ) {
 340                 int ld_errno;
 341                 ldap_perror( ld, "ldap_search" );
 342
 343                 ldap_get_option(ld, LDAP_OPT_ERROR_NUMBER, &ld_errno);
 344                 return( ld_errno );
 345     }
 346
 347     matches = 0;
 348     first = 1;
 349     while ( (rc = ldap_result( ld, LDAP_RES_ANY, sortattr ? 1 : 0, NULL, &res ))
 350             == LDAP_RES_SEARCH_ENTRY ) {
 351         matches++;
 352         e = ldap_first_entry( ld, res );
 353         if ( !first ) {
 354             putchar( '\n' );
 355         } else {
 356             first = 0;
 357         }
 358         print_entry( ld, e, attrsonly );
 359         ldap_msgfree( res );
 360     }
 361     if ( rc == -1 ) {
 362         ldap_perror( ld, "ldap_result" );
 363         return( rc );
 364     }
 365     if (( rc = ldap_result2error( ld, res, 0 )) != LDAP_SUCCESS ) {
 366         ldap_perror( ld, "ldap_search" );
 367     }
 368     if ( sortattr != NULL ) {
 369             (void) ldap_sort_entries( ld, &res,
 370                     ( *sortattr == '\0' ) ? NULL : sortattr, strcasecmp );
 371             matches = 0;
 372             first = 1;
 373             for ( e = ldap_first_entry( ld, res ); e != NULLMSG;
 374                     e = ldap_next_entry( ld, e ) ) {
 375                 matches++;
 376                 if ( !first ) {
 377                     putchar( '\n' );
 378                 } else {
 379                     first = 0;
 380                 }
 381                 print_entry( ld, e, attrsonly );
 382             }
 383     }
 384
 385     if ( verbose ) {
 386         printf( "%d matches\n", matches );
 387     }
 388
 389     ldap_msgfree( res );
 390     return( rc );
 391 }
 392
 393
 394 void print_entry(
 395     LDAP        *ld,
 396     LDAPMessage *entry,
 397     int         attrsonly)
 398 {
 399     char                *a, *dn, *ufn, tmpfname[ 64 ];
 400     int                 i, j, notascii;
 401     BerElement          *ber;
 402     struct berval       **bvals;
 403     FILE                *tmpfp;
 404
 405     dn = ldap_get_dn( ld, entry );
 406     if ( ldif ) {
 407         write_ldif_value( "dn", dn, strlen( dn ));
 408     } else {
 409         printf( "%s\n", dn );
 410     }
 411     if ( includeufn ) {
 412         ufn = ldap_dn2ufn( dn );
 413         if ( ldif ) {
 414             write_ldif_value( "ufn", ufn, strlen( ufn ));
 415         } else {
 416             printf( "%s\n", ufn );
 417         }
 418         free( ufn );
 419     }
 420     free( dn );
 421
 422     for ( a = ldap_first_attribute( ld, entry, &ber ); a != NULL;
 423             a = ldap_next_attribute( ld, entry, ber ) ) {
 424         if ( skipsortattr && strcasecmp( a, sortattr ) == 0 ) {
 425             continue;
 426         }
 427         if ( attrsonly ) {
 428             if ( ldif ) {
 429                 write_ldif_value( a, "", 0 );
 430             } else {
 431                 printf( "%s\n", a );
 432             }
 433         } else if (( bvals = ldap_get_values_len( ld, entry, a )) != NULL ) {
 434             for ( i = 0; bvals[i] != NULL; i++ ) {
 435                 if ( vals2tmp ) {
 436                     sprintf( tmpfname, "/tmp/ldapsearch-%s-XXXXXX", a );
 437                     tmpfp = NULL;
 438
 439                     if ( mktemp( tmpfname ) == NULL ) {
 440                         perror( tmpfname );
 441                     } else if (( tmpfp = fopen( tmpfname, "w")) == NULL ) {
 442                         perror( tmpfname );
 443                     } else if ( fwrite( bvals[ i ]->bv_val,
 444                             bvals[ i ]->bv_len, 1, tmpfp ) == 0 ) {
 445                         perror( tmpfname );
 446                     } else if ( ldif ) {
 447                         write_ldif_value( a, tmpfname, strlen( tmpfname ));
 448                     } else {
 449                         printf( "%s%s%s\n", a, sep, tmpfname );
 450                     }
 451
 452                     if ( tmpfp != NULL ) {
 453                         fclose( tmpfp );
 454                     }
 455                 } else {
 456                     notascii = 0;
 457                     if ( !allow_binary ) {
 458                         for ( j = 0; (unsigned long) j < bvals[ i ]->bv_len; ++j ) {
 459                             if ( !isascii( bvals[ i ]->bv_val[ j ] )) {
 460                                 notascii = 1;
 461                                 break;
 462                             }
 463                         }
 464                     }
 465
 466                     if ( ldif ) {
 467                         write_ldif_value( a, bvals[ i ]->bv_val,
 468                                 bvals[ i ]->bv_len );
 469                     } else {
 470                         printf( "%s%s%s\n", a, sep,
 471                                 notascii ? "NOT ASCII" : bvals[ i ]->bv_val );
 472                     }
 473                 }
 474             }
 475             ber_bvecfree( bvals );
 476         }
 477     }
 478 }
 479
 480
 481 int
 482 write_ldif_value( char *type, char *value, unsigned long vallen )
 483 {
 484     char        *ldif;
 485
 486     if (( ldif = ldif_type_and_value( type, value, (int)vallen )) == NULL ) {
 487         return( -1 );
 488     }
 489
 490     fputs( ldif, stdout );
 491     free( ldif );
 492
 493     return( 0 );
 494 }