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/signal.h>
   8 #include <ac/string.h>
   9 #include <ac/unistd.h>
  10
  11 #include <lber.h>
  12 #include <ldap.h>
  13 #include <ldif.h>
  14
  15 #define DEFSEP          "="
  16
  17
  18 static void
  19 usage( char *s )
  20 {
  21     fprintf( stderr, "usage: %s [options] filter [attributes...]\nwhere:\n", s );
  22     fprintf( stderr, "    filter\tRFC-1558 compliant LDAP search filter\n" );
  23     fprintf( stderr, "    attributes\twhitespace-separated list of attributes to retrieve\n" );
  24     fprintf( stderr, "\t\t(if no attribute list is given, all are retrieved)\n" );
  25     fprintf( stderr, "options:\n" );
  26     fprintf( stderr, "    -n\t\tshow what would be done but don't actually search\n" );
  27     fprintf( stderr, "    -v\t\trun in verbose mode (diagnostics to standard output)\n" );
  28     fprintf( stderr, "    -t\t\twrite values to files in /tmp\n" );
  29     fprintf( stderr, "    -u\t\tinclude User Friendly entry names in the output\n" );
  30     fprintf( stderr, "    -A\t\tretrieve attribute names only (no values)\n" );
  31     fprintf( stderr, "    -B\t\tdo not suppress printing of non-ASCII values\n" );
  32     fprintf( stderr, "    -L\t\tprint entries in LDIF format (-B is implied)\n" );
  33 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
  34     fprintf( stderr, "    -R\t\tdo not automatically follow referrals\n" );
  35 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
  36     fprintf( stderr, "    -d level\tset LDAP debugging level to `level'\n" );
  37     fprintf( stderr, "    -F sep\tprint `sep' instead of `=' between attribute names and values\n" );
  38     fprintf( stderr, "    -S attr\tsort the results by attribute `attr'\n" );
  39     fprintf( stderr, "    -f file\tperform sequence of searches listed in `file'\n" );
  40     fprintf( stderr, "    -b basedn\tbase dn for search\n" );
  41     fprintf( stderr, "    -s scope\tone of base, one, or sub (search scope)\n" );
  42     fprintf( stderr, "    -a deref\tone of never, always, search, or find (alias dereferencing)\n" );
  43     fprintf( stderr, "    -l time lim\ttime limit (in seconds) for search\n" );
  44     fprintf( stderr, "    -z size lim\tsize limit (in entries) for search\n" );
  45     fprintf( stderr, "    -D binddn\tbind dn\n" );
  46     fprintf( stderr, "    -w passwd\tbind passwd (for simple authentication)\n" );
  47     fprintf( stderr, "    -W\t\tprompt for bind passwd\n" );
  48 #ifdef HAVE_KERBEROS
  49     fprintf( stderr, "    -k\t\tuse Kerberos instead of Simple Password authentication\n" );
  50 #endif
  51     fprintf( stderr, "    -h host\tldap server\n" );
  52     fprintf( stderr, "    -p port\tport on ldap server\n" );
  53     fprintf( stderr, "    -P version\tprocotol version (2 or 3)\n" );
  54     exit( EXIT_FAILURE );
  55 }
  56
  57 static void print_entry LDAP_P((
  58     LDAP        *ld,
  59     LDAPMessage *entry,
  60     int         attrsonly));
  61
  62 static int write_ldif_value LDAP_P((
  63         char *type,
  64         char *value,
  65         unsigned long vallen ));
  66
  67 static int dosearch LDAP_P((
  68         LDAP    *ld,
  69     char        *base,
  70     int         scope,
  71     char        **attrs,
  72     int         attrsonly,
  73     char        *filtpatt,
  74     char        *value));
  75
  76 static char     *binddn = NULL;
  77 static char     *passwd = NULL;
  78 static char     *base = NULL;
  79 static char     *ldaphost = NULL;
  80 static int      ldapport = 0;
  81 static char     *sep = DEFSEP;
  82 static char     *sortattr = NULL;
  83 static int      skipsortattr = 0;
  84 static int      verbose, not, includeufn, allow_binary, vals2tmp, ldif;
  85
  86 int
  87 main( int argc, char **argv )
  88 {
  89     char                *infile, *filtpattern, **attrs, line[ BUFSIZ ];
  90     FILE                *fp;
  91     int                 rc, i, first, scope, deref, attrsonly;
  92     int                 referrals, timelimit, sizelimit, debug;
  93         int             authmethod, version, want_bindpw;
  94     LDAP                *ld;
  95
  96     infile = NULL;
  97     debug = verbose = allow_binary = not = vals2tmp =
  98             attrsonly = ldif = want_bindpw = 0;
  99
 100         deref = referrals = sizelimit = timelimit = version = -1;
 101
 102         scope = LDAP_SCOPE_SUBTREE;
 103     authmethod = LDAP_AUTH_SIMPLE;
 104
 105     while (( i = getopt( argc, argv, "WKknuvtRABLD:s:f:h:b:d:P:p:F:a:w:l:z:S:")) != EOF ) {
 106         switch( i ) {
 107         case 'n':       /* do Not do any searches */
 108             ++not;
 109             break;
 110         case 'v':       /* verbose mode */
 111             ++verbose;
 112             break;
 113         case 'd':
 114             debug |= atoi( optarg );
 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 ( strcasecmp( optarg, "base" ) == 0 ) {
 150                 scope = LDAP_SCOPE_BASE;
 151             } else if ( strcasecmp( optarg, "one" ) == 0 ) {
 152                 scope = LDAP_SCOPE_ONELEVEL;
 153             } else if ( strcasecmp( optarg, "sub" ) == 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 ( strcasecmp( optarg, "never" ) == 0 ) {
 163                 deref = LDAP_DEREF_NEVER;
 164             } else if ( strcasecmp( optarg, "search" ) == 0 ) {
 165                 deref = LDAP_DEREF_SEARCHING;
 166             } else if ( strcasecmp( optarg, "find" ) == 0 ) {
 167                 deref = LDAP_DEREF_FINDING;
 168             } else if ( strcasecmp( optarg, "always" ) == 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         case 'P':
 210                 switch( atoi( optarg ) )
 211                 {
 212                 case 2:
 213                         version = LDAP_VERSION2;
 214                         break;
 215                 case 3:
 216                         version = LDAP_VERSION3;
 217                         break;
 218                 default:
 219                         fprintf( stderr, "protocol version should be 2 or 3\n" );
 220                         usage( argv[0] );
 221                 }
 222                 break;
 223         default:
 224             usage( argv[0] );
 225         }
 226     }
 227
 228     if ( argc - optind < 1 ) {
 229         usage( argv[ 0 ] );
 230     }
 231     filtpattern = strdup( argv[ optind ] );
 232     if ( argv[ optind + 1 ] == NULL ) {
 233         attrs = NULL;
 234     } else if ( sortattr == NULL || *sortattr == '\0' ) {
 235         attrs = &argv[ optind + 1 ];
 236     } else {
 237         for ( i = optind + 1; i < argc; i++ ) {
 238             if ( strcasecmp( argv[ i ], sortattr ) == 0 ) {
 239                 break;
 240             }
 241         }
 242         if ( i == argc ) {
 243                 skipsortattr = 1;
 244                 argv[ optind ] = sortattr;
 245         } else {
 246                 optind++;
 247         }
 248         attrs = &argv[ optind ];
 249     }
 250
 251     if ( infile != NULL ) {
 252         if ( infile[0] == '-' && infile[1] == '\0' ) {
 253             fp = stdin;
 254         } else if (( fp = fopen( infile, "r" )) == NULL ) {
 255             perror( infile );
 256             return( EXIT_FAILURE );
 257         }
 258     }
 259
 260         if ( debug ) {
 261                 if( ber_set_option( NULL, LBER_OPT_DEBUG_LEVEL, &debug ) != LBER_OPT_ERROR ) {
 262                         fprintf( stderr, "Could not set LBER_OPT_DEBUG_LEVEL %d\n", debug );
 263                 }
 264                 if( ldap_set_option( NULL, LDAP_OPT_DEBUG_LEVEL, &debug ) != LDAP_OPT_ERROR ) {
 265                         fprintf( stderr, "Could not set LDAP_OPT_DEBUG_LEVEL %d\n", debug );
 266                 }
 267                 ldif_debug = debug;
 268         }
 269
 270 #ifdef SIGPIPE
 271         (void) SIGNAL( SIGPIPE, SIG_IGN );
 272 #endif
 273
 274     if ( verbose ) {
 275         fprintf( stderr, "ldap_init( %s, %d )\n",
 276                 (ldaphost != NULL) ? ldaphost : "<DEFAULT>",
 277                 ldapport );
 278     }
 279
 280     if (( ld = ldap_init( ldaphost, ldapport )) == NULL ) {
 281         perror( "ldap_init" );
 282         return( EXIT_FAILURE );
 283     }
 284
 285         if (deref != -1 &&
 286                 ldap_set_option( ld, LDAP_OPT_DEREF, (void *) &deref ) == LDAP_OPT_ERROR )
 287         {
 288                 fprintf( stderr, "Could not set LDAP_OPT_DEREF %d\n", deref );
 289         }
 290         if (timelimit != -1 &&
 291                 ldap_set_option( ld, LDAP_OPT_TIMELIMIT, (void *) &timelimit ) == LDAP_OPT_ERROR )
 292         {
 293                 fprintf( stderr, "Could not set LDAP_OPT_TIMELIMIT %d\n", timelimit );
 294         }
 295         if (sizelimit != -1 &&
 296                 ldap_set_option( ld, LDAP_OPT_SIZELIMIT, (void *) &sizelimit ) == LDAP_OPT_ERROR )
 297         {
 298                 fprintf( stderr, "Could not set LDAP_OPT_SIZELIMIT %d\n", sizelimit );
 299         }
 300         if (referrals != -1 &&
 301                 ldap_set_option( ld, LDAP_OPT_REFERRALS,
 302                                  (referrals ? LDAP_OPT_ON : LDAP_OPT_OFF) ) == LDAP_OPT_ERROR )
 303         {
 304                 fprintf( stderr, "Could not set LDAP_OPT_REFERRALS %s\n",
 305                         referrals ? "on" : "off" );
 306         }
 307
 308         if (version != -1 &&
 309                 ldap_set_option( ld, LDAP_OPT_PROTOCOL_VERSION, &version ) == LDAP_OPT_ERROR)
 310         {
 311                 fprintf( stderr, "Could not set LDAP_OPT_PROTOCOL_VERSION %d\n", version );
 312         }
 313
 314         if (want_bindpw)
 315                 passwd = getpass("Enter LDAP Password: ");
 316
 317     if ( ldap_bind_s( ld, binddn, passwd, authmethod ) != LDAP_SUCCESS ) {
 318         ldap_perror( ld, "ldap_bind" );
 319         return( EXIT_FAILURE );
 320     }
 321
 322     if ( verbose ) {
 323         fprintf( stderr, "filter pattern: %s\nreturning: ", filtpattern );
 324         if ( attrs == NULL ) {
 325             printf( "ALL" );
 326         } else {
 327             for ( i = 0; attrs[ i ] != NULL; ++i ) {
 328                 fprintf( stderr, "%s ", attrs[ i ] );
 329             }
 330         }
 331         fprintf( stderr, "\n" );
 332     }
 333
 334     if ( infile == NULL ) {
 335         rc = dosearch( ld, base, scope, attrs, attrsonly, filtpattern, "" );
 336     } else {
 337         rc = 0;
 338         first = 1;
 339         while ( rc == 0 && fgets( line, sizeof( line ), fp ) != NULL ) {
 340             line[ strlen( line ) - 1 ] = '\0';
 341             if ( !first ) {
 342                 putchar( '\n' );
 343             } else {
 344                 first = 0;
 345             }
 346             rc = dosearch( ld, base, scope, attrs, attrsonly, filtpattern,
 347                     line );
 348         }
 349         if ( fp != stdin ) {
 350             fclose( fp );
 351         }
 352     }
 353
 354     ldap_unbind( ld );
 355
 356
 357         return( rc );
 358 }
 359
 360
 361 static int dosearch(
 362         LDAP    *ld,
 363     char        *base,
 364     int         scope,
 365     char        **attrs,
 366     int         attrsonly,
 367     char        *filtpatt,
 368     char        *value)
 369 {
 370     char                filter[ BUFSIZ ];
 371     int                 rc, first, matches;
 372     LDAPMessage         *res, *e;
 373
 374     sprintf( filter, filtpatt, value );
 375
 376     if ( verbose ) {
 377         fprintf( stderr, "filter is: (%s)\n", filter );
 378     }
 379
 380     if ( not ) {
 381         return( LDAP_SUCCESS );
 382     }
 383
 384     if ( ldap_search( ld, base, scope, filter, attrs, attrsonly ) == -1 ) {
 385                 int ld_errno;
 386                 ldap_perror( ld, "ldap_search" );
 387
 388                 ldap_get_option(ld, LDAP_OPT_ERROR_NUMBER, &ld_errno);
 389                 return( ld_errno );
 390     }
 391
 392     matches = 0;
 393     first = 1;
 394     res = NULL;
 395     while ( (rc = ldap_result( ld, LDAP_RES_ANY, sortattr ? 1 : 0, NULL, &res ))
 396             == LDAP_RES_SEARCH_ENTRY ) {
 397         matches++;
 398         e = ldap_first_entry( ld, res );
 399         if ( !first ) {
 400             putchar( '\n' );
 401         } else {
 402             first = 0;
 403         }
 404         print_entry( ld, e, attrsonly );
 405         ldap_msgfree( res );
 406         res = NULL;
 407     }
 408     if ( rc == -1 ) {
 409         ldap_perror( ld, "ldap_result" );
 410         return( rc );
 411     }
 412     if (( rc = ldap_result2error( ld, res, 0 )) != LDAP_SUCCESS ) {
 413         ldap_perror( ld, "ldap_search" );
 414     }
 415     if ( sortattr != NULL ) {
 416             (void) ldap_sort_entries( ld, &res,
 417                     ( *sortattr == '\0' ) ? NULL : sortattr, strcasecmp );
 418             matches = 0;
 419             first = 1;
 420             for ( e = ldap_first_entry( ld, res ); e != NULL;
 421                     e = ldap_next_entry( ld, e ) ) {
 422                 matches++;
 423                 if ( !first ) {
 424                     putchar( '\n' );
 425                 } else {
 426                     first = 0;
 427                 }
 428                 print_entry( ld, e, attrsonly );
 429             }
 430     }
 431
 432     if ( verbose ) {
 433         printf( "%d matches\n", matches );
 434     }
 435
 436     ldap_msgfree( res );
 437     return( rc );
 438 }
 439
 440
 441 void print_entry(
 442     LDAP        *ld,
 443     LDAPMessage *entry,
 444     int         attrsonly)
 445 {
 446     char                *a, *dn, *ufn, tmpfname[ 64 ];
 447     int                 i, j, notascii;
 448     BerElement          *ber = NULL;
 449     struct berval       **bvals;
 450     FILE                *tmpfp;
 451
 452     dn = ldap_get_dn( ld, entry );
 453     if ( ldif ) {
 454         write_ldif_value( "dn", dn, strlen( dn ));
 455     } else {
 456         printf( "%s\n", dn );
 457     }
 458     if ( includeufn ) {
 459         ufn = ldap_dn2ufn( dn );
 460         if ( ldif ) {
 461             write_ldif_value( "ufn", ufn, strlen( ufn ));
 462         } else {
 463             printf( "%s\n", ufn );
 464         }
 465         ldap_memfree( ufn );
 466     }
 467     ldap_memfree( dn );
 468
 469     for ( a = ldap_first_attribute( ld, entry, &ber ); a != NULL;
 470             a = ldap_next_attribute( ld, entry, ber ) ) {
 471         if ( skipsortattr && strcasecmp( a, sortattr ) == 0 ) {
 472             continue;
 473         }
 474         if ( attrsonly ) {
 475             if ( ldif ) {
 476                 write_ldif_value( a, "", 0 );
 477             } else {
 478                 printf( "%s\n", a );
 479             }
 480         } else if (( bvals = ldap_get_values_len( ld, entry, a )) != NULL ) {
 481             for ( i = 0; bvals[i] != NULL; i++ ) {
 482                 if ( vals2tmp ) {
 483                     sprintf( tmpfname, "/tmp/ldapsearch-%s-XXXXXX", a );
 484                     tmpfp = NULL;
 485
 486                     if ( mktemp( tmpfname ) == NULL ) {
 487                         perror( tmpfname );
 488                     } else if (( tmpfp = fopen( tmpfname, "w")) == NULL ) {
 489                         perror( tmpfname );
 490                     } else if ( fwrite( bvals[ i ]->bv_val,
 491                             bvals[ i ]->bv_len, 1, tmpfp ) == 0 ) {
 492                         perror( tmpfname );
 493                     } else if ( ldif ) {
 494                         write_ldif_value( a, tmpfname, strlen( tmpfname ));
 495                     } else {
 496                         printf( "%s%s%s\n", a, sep, tmpfname );
 497                     }
 498
 499                     if ( tmpfp != NULL ) {
 500                         fclose( tmpfp );
 501                     }
 502                 } else {
 503                     notascii = 0;
 504                     if ( !allow_binary ) {
 505                         for ( j = 0; (unsigned long) j < bvals[ i ]->bv_len; ++j ) {
 506                             if ( !isascii( bvals[ i ]->bv_val[ j ] )) {
 507                                 notascii = 1;
 508                                 break;
 509                             }
 510                         }
 511                     }
 512
 513                     if ( ldif ) {
 514                         write_ldif_value( a, bvals[ i ]->bv_val,
 515                                 bvals[ i ]->bv_len );
 516                     } else {
 517                         printf( "%s%s%s\n", a, sep,
 518                                 notascii ? "NOT ASCII" : bvals[ i ]->bv_val );
 519                     }
 520                 }
 521             }
 522             ber_bvecfree( bvals );
 523         }
 524     }
 525
 526         if( ber != NULL ) {
 527                 ber_free( ber, 0 );
 528         }
 529 }
 530
 531
 532 int
 533 write_ldif_value( char *type, char *value, unsigned long vallen )
 534 {
 535     char        *ldif;
 536
 537     if (( ldif = ldif_type_and_value( type, value, (int)vallen )) == NULL ) {
 538         return( -1 );
 539     }
 540
 541     fputs( ldif, stdout );
 542     free( ldif );
 543
 544     return( 0 );
 545 }