openldap/clients/tools/ldapsearch.c

698 lines
16 KiB
C
Raw Normal View History

/* $OpenLDAP$ */
1999-08-05 07:55:45 +08:00
/*
* Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
* COPYING RESTRICTIONS APPLY, see COPYRIGHT file
*/
1998-10-25 09:41:42 +08:00
#include "portable.h"
1998-08-09 08:43:13 +08:00
#include <stdio.h>
1999-06-03 08:37:44 +08:00
#include <ac/stdlib.h>
1998-10-25 09:41:42 +08:00
1998-11-15 14:54:30 +08:00
#include <ac/ctype.h>
1999-01-21 06:01:14 +08:00
#include <ac/signal.h>
1998-10-25 09:41:42 +08:00
#include <ac/string.h>
#include <ac/unistd.h>
1998-08-09 08:43:13 +08:00
#include <ldap.h>
#include "ldif.h"
#include "ldap_defaults.h"
1998-08-09 08:43:13 +08:00
#define DEFSEP "="
static void
usage( const char *s )
1998-08-09 08:43:13 +08:00
{
fprintf( stderr,
"usage: %s [options] filter [attributes...]\nwhere:\n"
" filter\tRFC-1558 compliant LDAP search filter\n"
" attributes\twhitespace-separated list of attributes to retrieve\n"
"\t\t1.1 -- no attributes\n"
"\t\t* -- all user attributes\n"
"\t\t+ -- all operational attributes\n"
"\t\tempty list -- all non-operational attributes\n"
"options:\n"
" -n\t\tshow what would be done but don't actually search\n"
" -v\t\trun in verbose mode (diagnostics to standard output)\n"
" -t\t\twrite binary values to files in TMPDIR\n"
" -tt\t\twrite all values to files in TMPDIR\n"
" -T path\twrite files to directory specified by path (default: \"/tmp\")\n"
" -V prefix\tURL prefix for files (default: \"file://tmp/\"\n"
" -u\t\tinclude User Friendly entry names in the output\n"
" -A\t\tretrieve attribute names only (no values)\n"
" -B\t\tdo not suppress printing of binary values\n"
" -F sep\tprint `sep' instead of `=' between attribute names and values\n"
" -L\t\tprint entries in LDIF format (implies -B)\n"
" -LL\t\tprint entries in LDIF format without comments\n"
" -LLL\t\tprint entries in LDIF format without comments and version\n"
" -M\t\tenable Manage DSA IT control (-MM to make critical)\n"
" -R\t\tdo not automatically follow referrals\n"
" -S attr\tsort the results by attribute `attr'\n"
" -d level\tset LDAP debugging level to `level'\n"
" -f file\tperform sequence of searches listed in `file'\n"
" -b basedn\tbase dn for search\n"
" -s scope\tone of base, one, or sub (search scope)\n"
" -a deref\tone of never, always, search, or find (alias dereferencing)\n"
" -l limit\ttime limit (in seconds) for search\n"
" -z limit\tsize limit (in entries) for search\n"
" -D binddn\tbind dn\n"
" -w passwd\tbind passwd (for simple authentication)\n"
" -W\t\tprompt for bind passwd\n"
1998-10-25 09:41:42 +08:00
#ifdef HAVE_KERBEROS
" -k\t\tuse Kerberos instead of Simple Password authentication\n"
1998-08-09 08:43:13 +08:00
#endif
" -h host\tldap server\n"
" -p port\tport on ldap server\n"
" -P version\tprocotol version (2 or 3)\n"
, s );
exit( EXIT_FAILURE );
1998-08-09 08:43:13 +08:00
}
1998-10-25 09:41:42 +08:00
static void print_entry LDAP_P((
LDAP *ld,
LDAPMessage *entry,
int attrsonly));
1998-10-25 09:41:42 +08:00
static int write_ldif LDAP_P((
int type,
char *name,
1998-10-25 09:41:42 +08:00
char *value,
ber_len_t vallen ));
1998-10-25 09:41:42 +08:00
static int dosearch LDAP_P((
LDAP *ld,
char *base,
int scope,
char **attrs,
int attrsonly,
char *filtpatt,
char *value));
#define TMPDIR "/tmp"
#define URLPRE "file:/tmp/"
static char *tmpdir = NULL;
static char *urlpre = NULL;
1998-10-25 09:41:42 +08:00
static char *binddn = NULL;
static char *passwd = NULL;
static char *base = NULL;
static char *ldaphost = NULL;
static int ldapport = 0;
static char *sep = DEFSEP;
static char *sortattr = NULL;
1998-08-09 08:43:13 +08:00
static int skipsortattr = 0;
static int verbose, not, includeufn, binary, vals2tmp, ldif;
1998-08-09 08:43:13 +08:00
1998-11-04 21:15:18 +08:00
int
main( int argc, char **argv )
1998-08-09 08:43:13 +08:00
{
char *infile, *filtpattern, **attrs, line[ BUFSIZ ];
FILE *fp;
int rc, i, first, scope, deref, attrsonly, manageDSAit;
int referrals, timelimit, sizelimit, debug;
1998-12-27 22:08:46 +08:00
int authmethod, version, want_bindpw;
LDAP *ld;
infile = NULL;
debug = verbose = binary = not = vals2tmp =
attrsonly = manageDSAit = ldif = want_bindpw = 0;
1998-12-29 13:33:34 +08:00
1998-12-29 13:44:18 +08:00
deref = referrals = sizelimit = timelimit = version = -1;
1998-12-29 13:33:34 +08:00
1998-12-29 13:44:18 +08:00
scope = LDAP_SCOPE_SUBTREE;
authmethod = LDAP_AUTH_SIMPLE;
1998-08-09 08:43:13 +08:00
while (( i = getopt( argc, argv,
"WKknuvtMRABLD:s:f:h:b:d:P:p:F:a:w:l:z:S:T:V:")) != EOF )
{
switch( i ) {
case 'n': /* do Not do any searches */
++not;
break;
case 'v': /* verbose mode */
++verbose;
break;
1998-08-09 08:43:13 +08:00
case 'd':
debug |= atoi( optarg );
break;
case 'k': /* use kerberos bind */
1998-12-15 04:39:02 +08:00
#ifdef HAVE_KERBEROS
authmethod = LDAP_AUTH_KRBV4;
#else
fprintf (stderr, "%s was not compiled with Kerberos support\n", argv[0]);
#endif
break;
1998-08-09 08:43:13 +08:00
case 'K': /* use kerberos bind, 1st part only */
1998-12-15 04:39:02 +08:00
#ifdef HAVE_KERBEROS
authmethod = LDAP_AUTH_KRBV41;
#else
fprintf (stderr, "%s was not compiled with Kerberos support\n", argv[0]);
1998-08-09 08:43:13 +08:00
#endif
break;
case 'u': /* include UFN */
++includeufn;
break;
case 't': /* write attribute values to /tmp files */
++vals2tmp;
break;
case 'M':
/* enable Manage DSA IT */
manageDSAit++;
break;
case 'R': /* don't automatically chase referrals */
referrals = (int) LDAP_OPT_OFF;
break;
case 'A': /* retrieve attribute names only -- no values */
++attrsonly;
break;
case 'L': /* print entries in LDIF format */
++ldif;
/* fall through -- always allow binary when outputting LDIF */
case 'B': /* allow binary values to be printed */
++binary;
break;
1998-08-09 08:43:13 +08:00
case 's': /* search scope */
if ( strcasecmp( optarg, "base" ) == 0 ) {
1998-08-09 08:43:13 +08:00
scope = LDAP_SCOPE_BASE;
} else if ( strcasecmp( optarg, "one" ) == 0 ) {
1998-08-09 08:43:13 +08:00
scope = LDAP_SCOPE_ONELEVEL;
} else if ( strcasecmp( optarg, "sub" ) == 0 ) {
1998-08-09 08:43:13 +08:00
scope = LDAP_SCOPE_SUBTREE;
} else {
1998-08-09 08:43:13 +08:00
fprintf( stderr, "scope should be base, one, or sub\n" );
usage( argv[ 0 ] );
}
break;
1998-08-09 08:43:13 +08:00
case 'a': /* set alias deref option */
if ( strcasecmp( optarg, "never" ) == 0 ) {
deref = LDAP_DEREF_NEVER;
} else if ( strcasecmp( optarg, "search" ) == 0 ) {
deref = LDAP_DEREF_SEARCHING;
} else if ( strcasecmp( optarg, "find" ) == 0 ) {
deref = LDAP_DEREF_FINDING;
} else if ( strcasecmp( optarg, "always" ) == 0 ) {
deref = LDAP_DEREF_ALWAYS;
} else {
fprintf( stderr, "alias deref should be never, search, find, or always\n" );
usage( argv[ 0 ] );
}
break;
case 'T': /* field separator */
if( tmpdir ) free( tmpdir );
tmpdir = strdup( optarg );
break;
case 'V': /* field separator */
if( urlpre ) free( urlpre );
urlpre = strdup( optarg );
break;
case 'F': /* field separator */
sep = strdup( optarg );
break;
case 'f': /* input file */
infile = strdup( optarg );
break;
case 'h': /* ldap host */
ldaphost = strdup( optarg );
break;
case 'b': /* searchbase */
base = strdup( optarg );
break;
case 'D': /* bind DN */
binddn = strdup( optarg );
break;
case 'p': /* ldap port */
ldapport = atoi( optarg );
break;
case 'w': /* bind password */
passwd = strdup( optarg );
{
char* p;
1999-07-01 12:39:42 +08:00
for( p = optarg; *p == '\0'; p++ ) {
*p = '*';
}
}
break;
case 'l': /* time limit */
timelimit = atoi( optarg );
break;
case 'z': /* size limit */
sizelimit = atoi( optarg );
break;
case 'S': /* sort attribute */
sortattr = strdup( optarg );
break;
case 'W':
want_bindpw++;
break;
1998-12-27 22:08:46 +08:00
case 'P':
switch( atoi( optarg ) )
1998-12-27 22:08:46 +08:00
{
case 2:
1998-12-27 22:08:46 +08:00
version = LDAP_VERSION2;
break;
case 3:
1998-12-27 22:08:46 +08:00
version = LDAP_VERSION3;
break;
default:
fprintf( stderr, "protocol version should be 2 or 3\n" );
usage( argv[0] );
1998-12-27 22:08:46 +08:00
}
break;
default:
usage( argv[0] );
1998-08-09 08:43:13 +08:00
}
}
if ( argc - optind < 1 ) {
usage( argv[ 0 ] );
}
filtpattern = strdup( argv[ optind ] );
if ( argv[ optind + 1 ] == NULL ) {
attrs = NULL;
} else if ( sortattr == NULL || *sortattr == '\0' ) {
attrs = &argv[ optind + 1 ];
1998-08-09 08:43:13 +08:00
} else {
for ( i = optind + 1; i < argc; i++ ) {
if ( strcasecmp( argv[ i ], sortattr ) == 0 ) {
break;
}
}
if ( i == argc ) {
skipsortattr = 1;
argv[ optind ] = sortattr;
} else {
optind++;
}
attrs = &argv[ optind ];
}
if ( infile != NULL ) {
if ( infile[0] == '-' && infile[1] == '\0' ) {
fp = stdin;
} else if (( fp = fopen( infile, "r" )) == NULL ) {
perror( infile );
return EXIT_FAILURE;
}
}
if( tmpdir == NULL
&& (tmpdir = getenv("TMPDIR")) == NULL
&& (tmpdir = getenv("TMP")) == NULL
&& (tmpdir = getenv("TEMP")) == NULL )
{
tmpdir = "/tmp";
1998-08-09 08:43:13 +08:00
}
if( urlpre == NULL ) {
urlpre = malloc( sizeof("file:///") + strlen(tmpdir) );
if( urlpre == NULL ) {
perror( "malloc" );
return EXIT_FAILURE;
}
sprintf( urlpre, "file:///%s/",
tmpdir[0] == '/' ? &tmpdir[1] : tmpdir );
/* urlpre should be URLized.... */
1998-08-09 08:43:13 +08:00
}
if ( debug ) {
if( ber_set_option( NULL, LBER_OPT_DEBUG_LEVEL, &debug ) != LBER_OPT_SUCCESS ) {
fprintf( stderr, "Could not set LBER_OPT_DEBUG_LEVEL %d\n", debug );
}
if( ldap_set_option( NULL, LDAP_OPT_DEBUG_LEVEL, &debug ) != LDAP_OPT_SUCCESS ) {
fprintf( stderr, "Could not set LDAP_OPT_DEBUG_LEVEL %d\n", debug );
}
ldif_debug = debug;
}
1999-01-21 06:01:14 +08:00
#ifdef SIGPIPE
(void) SIGNAL( SIGPIPE, SIG_IGN );
#endif
if ( verbose ) {
fprintf( stderr,
(ldapport ? "ldap_init( %s, %d )\n" : "ldap_init( %s, <DEFAULT> )\n"),
(ldaphost != NULL) ? ldaphost : "<DEFAULT>",
ldapport );
}
if (( ld = ldap_init( ldaphost, ldapport )) == NULL ) {
perror( "ldap_init" );
return( EXIT_FAILURE );
}
1998-12-29 13:33:34 +08:00
if (deref != -1 &&
ldap_set_option( ld, LDAP_OPT_DEREF, (void *) &deref ) != LDAP_OPT_SUCCESS )
1998-12-29 13:33:34 +08:00
{
fprintf( stderr, "Could not set LDAP_OPT_DEREF %d\n", deref );
}
1998-12-29 13:33:34 +08:00
if (timelimit != -1 &&
ldap_set_option( ld, LDAP_OPT_TIMELIMIT, (void *) &timelimit ) != LDAP_OPT_SUCCESS )
1998-12-29 13:33:34 +08:00
{
fprintf( stderr, "Could not set LDAP_OPT_TIMELIMIT %d\n", timelimit );
}
1998-12-29 13:33:34 +08:00
if (sizelimit != -1 &&
ldap_set_option( ld, LDAP_OPT_SIZELIMIT, (void *) &sizelimit ) != LDAP_OPT_SUCCESS )
1998-12-29 13:33:34 +08:00
{
fprintf( stderr, "Could not set LDAP_OPT_SIZELIMIT %d\n", sizelimit );
}
1998-12-29 13:33:34 +08:00
if (referrals != -1 &&
ldap_set_option( ld, LDAP_OPT_REFERRALS,
(referrals ? LDAP_OPT_ON : LDAP_OPT_OFF) ) != LDAP_OPT_SUCCESS )
1998-12-29 13:33:34 +08:00
{
fprintf( stderr, "Could not set LDAP_OPT_REFERRALS %s\n",
referrals ? "on" : "off" );
}
1998-12-29 13:33:34 +08:00
if (version != -1 &&
ldap_set_option( ld, LDAP_OPT_PROTOCOL_VERSION, &version ) != LDAP_OPT_SUCCESS )
1998-12-29 13:33:34 +08:00
{
fprintf( stderr, "Could not set LDAP_OPT_PROTOCOL_VERSION %d\n", version );
1998-12-27 22:08:46 +08:00
}
if (want_bindpw) {
passwd = getpass("Enter LDAP Password: ");
}
if ( ldap_bind_s( ld, binddn, passwd, authmethod ) != LDAP_SUCCESS ) {
ldap_perror( ld, "ldap_bind" );
return( EXIT_FAILURE );
1998-08-09 08:43:13 +08:00
}
if ( manageDSAit ) {
int err;
LDAPControl c;
LDAPControl *ctrls[2];
ctrls[0] = &c;
ctrls[1] = NULL;
c.ldctl_oid = LDAP_CONTROL_MANAGEDSAIT;
c.ldctl_value.bv_val = NULL;
c.ldctl_value.bv_len = 0;
c.ldctl_iscritical = manageDSAit > 1;
err = ldap_set_option( ld, LDAP_OPT_SERVER_CONTROLS, &ctrls );
if( err != LDAP_OPT_SUCCESS ) {
fprintf( stderr, "Could not set Manage DSA IT Control\n" );
if( c.ldctl_iscritical ) {
exit( EXIT_FAILURE );
}
}
}
if ( verbose ) {
fprintf( stderr, "filter%s: %s\nreturning: ",
infile != NULL ? " pattern" : "",
filtpattern );
if ( attrs == NULL ) {
1999-08-17 03:09:40 +08:00
fprintf( stderr, "ALL" );
} else {
for ( i = 0; attrs[ i ] != NULL; ++i ) {
fprintf( stderr, "%s ", attrs[ i ] );
}
}
fprintf( stderr, "\n" );
1998-08-09 08:43:13 +08:00
}
if ( ldif ) {
if (ldif < 3 ) {
printf( "version: 1\n\n");
}
if (ldif < 2 ) {
printf( "#\n# filter%s: %s\n# returning: ",
infile != NULL ? " pattern" : "",
filtpattern );
if ( attrs == NULL ) {
printf( "ALL" );
} else {
for ( i = 0; attrs[ i ] != NULL; ++i ) {
printf( "%s ", attrs[ i ] );
}
}
printf( "\n#\n\n" );
}
1998-08-09 08:43:13 +08:00
}
if ( infile == NULL ) {
rc = dosearch( ld, base, scope, attrs, attrsonly, NULL, filtpattern );
} else {
rc = 0;
first = 1;
while ( rc == 0 && fgets( line, sizeof( line ), fp ) != NULL ) {
line[ strlen( line ) - 1 ] = '\0';
if ( !first ) {
putchar( '\n' );
} else {
first = 0;
}
rc = dosearch( ld, base, scope, attrs, attrsonly,
filtpattern, line );
}
if ( fp != stdin ) {
fclose( fp );
}
}
ldap_unbind( ld );
return( rc );
1998-08-09 08:43:13 +08:00
}
1998-10-25 09:41:42 +08:00
static int dosearch(
LDAP *ld,
char *base,
int scope,
char **attrs,
int attrsonly,
char *filtpatt,
char *value)
1998-08-09 08:43:13 +08:00
{
char filter[ BUFSIZ ];
int rc, first, matches;
LDAPMessage *res, *e;
if( filtpatt != NULL ) {
sprintf( filter, filtpatt, value );
1998-08-09 08:43:13 +08:00
if ( verbose ) {
fprintf( stderr, "filter is: (%s)\n", filter );
}
1998-08-09 08:43:13 +08:00
if( ldif == 1 ) {
printf( "#\n# filter: %s\n#\n", filter );
}
1998-08-09 08:43:13 +08:00
} else {
sprintf( filter, "%s", value );
}
1998-08-09 08:43:13 +08:00
if ( not ) {
return( LDAP_SUCCESS );
}
if ( ldap_search( ld, base, scope, filter, attrs, attrsonly ) == -1 ) {
int ld_errno;
ldap_perror( ld, "ldap_search" );
ldap_get_option(ld, LDAP_OPT_ERROR_NUMBER, &ld_errno);
return( ld_errno );
}
1998-08-09 08:43:13 +08:00
matches = 0;
first = 1;
res = NULL;
while ( (rc = ldap_result( ld, LDAP_RES_ANY, sortattr ? 1 : 0, NULL, &res ))
== LDAP_RES_SEARCH_ENTRY ) {
1998-08-09 08:43:13 +08:00
matches++;
e = ldap_first_entry( ld, res );
if ( !first ) {
putchar( '\n' );
1998-08-09 08:43:13 +08:00
} else {
first = 0;
1998-08-09 08:43:13 +08:00
}
print_entry( ld, e, attrsonly );
ldap_msgfree( res );
res = NULL;
}
if ( rc == -1 ) {
1998-08-09 08:43:13 +08:00
ldap_perror( ld, "ldap_result" );
return( rc );
}
if (( rc = ldap_result2error( ld, res, 0 )) != LDAP_SUCCESS ) {
ldap_perror( ld, "ldap_search" );
}
if ( sortattr != NULL ) {
(void) ldap_sort_entries( ld, &res,
( *sortattr == '\0' ) ? NULL : sortattr, strcasecmp );
matches = 0;
first = 1;
for ( e = ldap_first_entry( ld, res ); e != NULL;
e = ldap_next_entry( ld, e ) ) {
1998-08-09 08:43:13 +08:00
matches++;
if ( !first ) {
putchar( '\n' );
1998-08-09 08:43:13 +08:00
} else {
first = 0;
1998-08-09 08:43:13 +08:00
}
print_entry( ld, e, attrsonly );
}
}
1998-08-09 08:43:13 +08:00
if ( verbose ) {
printf( "%d matches\n", matches );
}
1998-08-09 08:43:13 +08:00
ldap_msgfree( res );
return( rc );
1998-08-09 08:43:13 +08:00
}
static void
print_entry(
LDAP *ld,
LDAPMessage *entry,
int attrsonly)
1998-08-09 08:43:13 +08:00
{
char *a, *dn, *ufn;
char tmpfname[ 256 ];
char url[ 256 ];
int i;
BerElement *ber = NULL;
struct berval **bvals;
FILE *tmpfp;
dn = ldap_get_dn( ld, entry );
ufn = NULL;
if ( ldif == 1 ) {
ufn = ldap_dn2ufn( dn );
write_ldif( LDIF_PUT_COMMENT, NULL, ufn, strlen( ufn ));
}
1998-08-09 08:43:13 +08:00
if ( ldif ) {
write_ldif( LDIF_PUT_VALUE, "dn", dn, strlen( dn ));
1998-08-09 08:43:13 +08:00
} else {
printf( "%s\n", dn );
}
if ( includeufn ) {
if( ufn == NULL ) {
ufn = ldap_dn2ufn( dn );
}
if ( ldif ) {
write_ldif( LDIF_PUT_VALUE, "ufn", ufn, strlen( ufn ));
1998-08-09 08:43:13 +08:00
} else {
printf( "%s\n", ufn );
}
}
if( ufn != NULL ) ldap_memfree( ufn );
ldap_memfree( dn );
for ( a = ldap_first_attribute( ld, entry, &ber ); a != NULL;
a = ldap_next_attribute( ld, entry, ber ) )
{
if ( skipsortattr && strcasecmp( a, sortattr ) == 0 ) {
continue;
}
if ( attrsonly ) {
if ( ldif ) {
write_ldif( LDIF_PUT_NOVALUE, a, NULL, 0 );
} else {
printf( "%s\n", a );
1998-08-09 08:43:13 +08:00
}
} else if (( bvals = ldap_get_values_len( ld, entry, a )) != NULL ) {
for ( i = 0; bvals[i] != NULL; i++ ) {
if ( vals2tmp > 1 || ( vals2tmp
&& ldif_is_not_printable( bvals[i]->bv_val, bvals[i]->bv_len ) ))
{
/* write value to file */
sprintf( tmpfname, "%s" LDAP_DIRSEP "ldapsearch-%s-XXXXXX",
tmpdir, a );
tmpfp = NULL;
if ( mktemp( tmpfname ) == NULL ) {
perror( tmpfname );
continue;
}
if (( tmpfp = fopen( tmpfname, "w")) == NULL ) {
perror( tmpfname );
continue;
}
if ( fwrite( bvals[ i ]->bv_val,
bvals[ i ]->bv_len, 1, tmpfp ) == 0 )
{
perror( tmpfname );
fclose( tmpfp );
continue;
}
fclose( tmpfp );
sprintf( url, "%s%s", urlpre,
&tmpfname[strlen(tmpdir) + sizeof(LDAP_DIRSEP) - 1] );
if ( ldif ) {
write_ldif( LDIF_PUT_URL, a, url, strlen( url ));
} else {
printf( "%s%s%s\n", a, sep, url );
}
} else {
if ( ldif ) {
write_ldif( LDIF_PUT_VALUE, a,
bvals[ i ]->bv_val, bvals[ i ]->bv_len );
} else {
int notprint = !binary && !vals2tmp
&& ldif_is_not_printable( bvals[i]->bv_val,
bvals[i]->bv_len );
printf( "%s%s", a, sep );
puts( notprint ? "NOT PRINTABLE" : bvals[ i ]->bv_val );
}
}
}
ber_bvecfree( bvals );
1998-08-09 08:43:13 +08:00
}
}
if( ber != NULL ) {
ber_free( ber, 0 );
}
1998-08-09 08:43:13 +08:00
}
static int
write_ldif( int type, char *name, char *value, ber_len_t vallen )
1998-08-09 08:43:13 +08:00
{
char *ldif;
1998-08-09 08:43:13 +08:00
if (( ldif = ldif_put( type, name, value, vallen )) == NULL ) {
return( -1 );
}
1998-08-09 08:43:13 +08:00
fputs( ldif, stdout );
ber_memfree( ldif );
1998-08-09 08:43:13 +08:00
return( 0 );
1998-08-09 08:43:13 +08:00
}