1 /* ldapsearch -- a tool for searching LDAP directories */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2004 The OpenLDAP Foundation.
6 * Portions Copyright 1998-2003 Kurt D. Zeilenga.
7 * Portions Copyright 1998-2001 Net Boolean Incorporated.
8 * Portions Copyright 2001-2003 IBM Corporation.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted only as authorized by the OpenLDAP
15 * A copy of this license is available in the file LICENSE in the
16 * top-level directory of the distribution or, alternatively, at
17 * <http://www.OpenLDAP.org/license.html>.
19 /* Portions Copyright (c) 1992-1996 Regents of the University of Michigan.
20 * All rights reserved.
22 * Redistribution and use in source and binary forms are permitted
23 * provided that this notice is preserved and that due credit is given
24 * to the University of Michigan at Ann Arbor. The name of the
25 * University may not be used to endorse or promote products derived
26 * from this software without specific prior written permission. This
27 * software is provided ``as is'' without express or implied warranty.
30 * This work was originally developed by the University of Michigan
31 * (as part of U-MICH LDAP). Additional significant contributors
43 #include <ac/stdlib.h>
46 #include <ac/string.h>
47 #include <ac/unistd.h>
54 #ifdef HAVE_SYS_TYPES_H
55 #include <sys/types.h>
65 #include "lutil_ldap.h"
66 #include "ldap_defaults.h"
73 static int scope = LDAP_SCOPE_SUBTREE;
74 static int deref = -1;
76 static int timelimit = -1;
77 static int sizelimit = -1;
79 static char *def_tmpdir;
80 static char *def_urlpre;
82 #if defined(__CYGWIN__) || defined(__MINGW32__)
83 /* Turn off commandline globbing, otherwise you cannot search for
92 fprintf( stderr, _("usage: %s [options] [filter [attributes...]]\nwhere:\n"), prog);
93 fprintf( stderr, _(" filter\tRFC-2254 compliant LDAP search filter\n"));
94 fprintf( stderr, _(" attributes\twhitespace-separated list of attribute descriptions\n"));
95 fprintf( stderr, _(" which may include:\n"));
96 fprintf( stderr, _(" 1.1 no attributes\n"));
97 fprintf( stderr, _(" * all user attributes\n"));
98 fprintf( stderr, _(" + all operational attributes\n"));
101 fprintf( stderr, _("Search options:\n"));
102 fprintf( stderr, _(" -a deref one of never (default), always, search, or find\n"));
103 fprintf( stderr, _(" -A retrieve attribute names only (no values)\n"));
104 fprintf( stderr, _(" -b basedn base dn for search\n"));
105 fprintf( stderr, _(" -E [!]<ext>[=<extparam>] search extensions (! indicates criticality)\n"));
106 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
107 fprintf( stderr, _(" [!]domainScope (domain scope)\n"));
109 fprintf( stderr, _(" [!]mv=<filter> (matched values filter)\n"));
110 #ifdef LDAP_CONTROL_PAGEDRESULTS
111 fprintf( stderr, _(" [!]pr=<size>[/prompt|noprompt] (paged results/prompt)\n"));
113 #ifdef LDAP_CONTROL_SUBENTRIES
114 fprintf( stderr, _(" [!]subentries[=true|false] (subentries)\n"));
116 fprintf( stderr, _(" [!]sync=ro[/<cookie>] (LDAP Sync refreshOnly)\n"));
117 fprintf( stderr, _(" rp[/<cookie>][/<slimit>] (LDAP Sync refreshAndPersist)\n"));
118 fprintf( stderr, _(" -F prefix URL prefix for files (default: %s)\n"), def_urlpre);
119 fprintf( stderr, _(" -l limit time limit (in seconds) for search\n"));
120 fprintf( stderr, _(" -L print responses in LDIFv1 format\n"));
121 fprintf( stderr, _(" -LL print responses in LDIF format without comments\n"));
122 fprintf( stderr, _(" -LLL print responses in LDIF format without comments\n"));
123 fprintf( stderr, _(" and version\n"));
124 fprintf( stderr, _(" -s scope one of base, one, or sub (search scope)\n"));
125 fprintf( stderr, _(" -S attr sort the results by attribute `attr'\n"));
126 fprintf( stderr, _(" -t write binary values to files in temporary directory\n"));
127 fprintf( stderr, _(" -tt write all values to files in temporary directory\n"));
128 fprintf( stderr, _(" -T path write files to directory specified by path (default: %s)\n"), def_tmpdir);
129 fprintf( stderr, _(" -u include User Friendly entry names in the output\n"));
130 fprintf( stderr, _(" -z limit size limit (in entries) for search\n"));
132 exit( EXIT_FAILURE );
135 static void print_entry LDAP_P((
140 static void print_reference(
142 LDAPMessage *reference );
144 static void print_extended(
146 LDAPMessage *extended );
148 static void print_partial(
150 LDAPMessage *partial );
152 static int print_result(
157 static void print_ctrls(
158 LDAPControl **ctrls );
160 static int write_ldif LDAP_P((
166 static int dosearch LDAP_P((
174 LDAPControl **sctrls,
175 LDAPControl **cctrls,
176 struct timeval *timeout,
179 static char *tmpdir = NULL;
180 static char *urlpre = NULL;
181 static char *base = NULL;
182 static char *sortattr = NULL;
183 static int includeufn, vals2tmp = 0, ldif = 0;
185 static int subentries = 0, valuesReturnFilter = 0;
186 static char *vrFilter = NULL;
188 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
189 static int domainScope = 0;
192 static int ldapsync = 0;
193 static struct berval sync_cookie = { 0, NULL };
194 static int sync_slimit = -1;
196 #ifdef LDAP_CONTROL_PAGEDRESULTS
197 static int pagedResults = 0;
198 static int pagePrompt = 1;
199 static ber_int_t pageSize = 0;
200 static ber_int_t entriesLeft = 0;
201 static ber_int_t morePagedResults = 1;
202 static struct berval cookie = { 0, NULL };
203 static int npagedresponses;
204 static int npagedentries;
205 static int npagedreferences;
206 static int npagedextended;
207 static int npagedpartial;
209 static int parse_page_control(
212 struct berval *cookie );
220 if (*LDAP_DIRSEP != '/') {
221 for (p = url; *p; p++) {
222 if (*p == *LDAP_DIRSEP)
229 const char options[] = "a:Ab:E:F:l:Ls:S:tT:uz:"
230 "Cd:D:e:f:h:H:IkKMnO:p:P:QR:U:vVw:WxX:y:Y:Z";
233 handle_private_option( int i )
236 char *control, *cvalue;
238 case 'a': /* set alias deref option */
239 if ( strcasecmp( optarg, "never" ) == 0 ) {
240 deref = LDAP_DEREF_NEVER;
241 } else if ( strncasecmp( optarg, "search", sizeof("search")-1 ) == 0 ) {
242 deref = LDAP_DEREF_SEARCHING;
243 } else if ( strncasecmp( optarg, "find", sizeof("find")-1 ) == 0 ) {
244 deref = LDAP_DEREF_FINDING;
245 } else if ( strcasecmp( optarg, "always" ) == 0 ) {
246 deref = LDAP_DEREF_ALWAYS;
249 _("alias deref should be never, search, find, or always\n") );
253 case 'A': /* retrieve attribute names only -- no values */
256 case 'b': /* search base */
257 base = ber_strdup( optarg );
259 case 'E': /* search extensions */
260 if( protocol == LDAP_VERSION2 ) {
261 fprintf( stderr, _("%s: -E incompatible with LDAPv%d\n"),
263 exit( EXIT_FAILURE );
266 /* should be extended to support comma separated list of
267 * [!]key[=value] parameters, e.g. -E !foo,bar=567
272 if( optarg[0] == '!' ) {
277 control = ber_strdup( optarg );
278 if ( (cvalue = strchr( control, '=' )) != NULL ) {
282 if ( strcasecmp( control, "mv" ) == 0 ) {
283 /* ValuesReturnFilter control */
284 if( valuesReturnFilter ) {
286 _("ValuesReturnFilter previously specified\n"));
287 exit( EXIT_FAILURE );
289 valuesReturnFilter= 1 + crit;
291 if ( cvalue == NULL ) {
293 _("missing filter in ValuesReturnFilter control\n"));
294 exit( EXIT_FAILURE );
298 protocol = LDAP_VERSION3;
300 #ifdef LDAP_CONTROL_PAGEDRESULTS
301 } else if ( strcasecmp( control, "pr" ) == 0 ) {
303 /* PagedResults control */
304 if ( pagedResults != 0 ) {
306 _("PagedResultsControl previously specified\n") );
307 exit( EXIT_FAILURE );
310 if( cvalue != NULL ) {
313 promptp = strchr( cvalue, '/' );
314 if ( promptp != NULL ) {
316 if ( strcasecmp( promptp, "prompt" ) == 0 ) {
318 } else if ( strcasecmp( promptp, "noprompt" ) == 0) {
322 _("Invalid value for PagedResultsControl,"
323 " %s/%s.\n"), cvalue, promptp );
324 exit( EXIT_FAILURE );
327 num = sscanf( cvalue, "%d", &tmp );
330 _("Invalid value for PagedResultsControl, %s.\n"),
332 exit( EXIT_FAILURE );
335 fprintf( stderr, _("Invalid value for PagedResultsControl.\n"),
337 exit( EXIT_FAILURE );
339 pageSize = (ber_int_t) tmp;
340 pagedResults = 1 + crit;
343 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
344 } else if ( strcasecmp( control, "domainScope" ) == 0 ) {
347 _("domainScope control previously specified\n"));
348 exit( EXIT_FAILURE );
350 if( cvalue != NULL ) {
352 _("domainScope: no control value expected\n") );
356 domainScope = 1 + crit;
358 #ifdef LDAP_CONTROL_SUBENTRIES
359 } else if ( strcasecmp( control, "subentries" ) == 0 ) {
362 _("subentries control previously specified\n"));
363 exit( EXIT_FAILURE );
365 if( cvalue == NULL || strcasecmp( cvalue, "true") == 0 ) {
367 } else if ( strcasecmp( cvalue, "false") == 0 ) {
371 _("subentries control value \"%s\" invalid\n"),
373 exit( EXIT_FAILURE );
375 if( crit ) subentries *= -1;
378 } else if ( strcasecmp( control, "sync" ) == 0 ) {
382 fprintf( stderr, _("sync control previously specified\n") );
383 exit( EXIT_FAILURE );
385 if ( cvalue == NULL ) {
386 fprintf( stderr, _("missing specification of sync control\n"));
387 exit( EXIT_FAILURE );
389 if ( strncasecmp( cvalue, "ro", 2 ) == 0 ) {
390 ldapsync = LDAP_SYNC_REFRESH_ONLY;
391 cookiep = strchr( cvalue, '/' );
392 if ( cookiep != NULL ) {
394 if ( *cookiep != '\0' ) {
395 ber_str2bv( cookiep, 0, 0, &sync_cookie );
398 } else if ( strncasecmp( cvalue, "rp", 2 ) == 0 ) {
399 ldapsync = LDAP_SYNC_REFRESH_AND_PERSIST;
400 cookiep = strchr( cvalue, '/' );
401 if ( cookiep != NULL ) {
405 slimitp = strchr( cvalue, '/' );
406 if ( slimitp != NULL ) {
409 if ( cookiep != NULL && *cookiep != '\0' )
410 ber_str2bv( cookiep, 0, 0, &sync_cookie );
411 if ( slimitp != NULL && *slimitp != '\0' )
412 sync_slimit = atoi( slimitp );
414 fprintf( stderr, _("sync control value \"%s\" invalid\n"),
416 exit( EXIT_FAILURE );
418 if ( crit ) ldapsync *= -1;
421 fprintf( stderr, _("Invalid search extension name: %s\n"),
426 case 'F': /* uri prefix */
427 if( urlpre ) free( urlpre );
428 urlpre = strdup( optarg );
430 case 'l': /* time limit */
431 if ( strcasecmp( optarg, "none" ) == 0 ) {
432 /* maxInt as per RFC 4.1.1. Message Envelope */
433 sizelimit = 2147483647;
435 timelimit = atoi( optarg );
437 if( timelimit < 0 ) {
438 fprintf( stderr, _("%s: invalid timelimit (%d) specified\n"),
440 exit( EXIT_FAILURE );
443 case 'L': /* print entries in LDIF format */
446 case 's': /* search scope */
447 if ( strncasecmp( optarg, "base", sizeof("base"-1) ) == 0 ) {
448 scope = LDAP_SCOPE_BASE;
449 } else if ( strncasecmp( optarg, "one", sizeof("one")-1 ) == 0 ) {
450 scope = LDAP_SCOPE_ONELEVEL;
451 #ifdef LDAP_SCOPE_SUBORDINATE
452 } else if (( strcasecmp( optarg, "subordinate" ) == 0 )
453 || ( strcasecmp( optarg, "children" ) == 0 ))
455 scope = LDAP_SCOPE_SUBORDINATE;
457 } else if ( strncasecmp( optarg, "sub", sizeof("sub")-1 ) == 0 ) {
458 scope = LDAP_SCOPE_SUBTREE;
460 fprintf( stderr, _("scope should be base, one, or sub\n") );
464 case 'S': /* sort attribute */
465 sortattr = strdup( optarg );
467 case 't': /* write attribute values to TMPDIR files */
470 case 'T': /* tmpdir */
471 if( tmpdir ) free( tmpdir );
472 tmpdir = strdup( optarg );
474 case 'u': /* include UFN */
477 case 'z': /* size limit */
478 if ( strcasecmp( optarg, "none" ) == 0 ) {
479 /* maxInt as per RFC 4.1.1. Message Envelope */
480 sizelimit = 2147483647;
482 sizelimit = atoi( optarg );
493 private_conn_setup( LDAP *ld )
496 ldap_set_option( ld, LDAP_OPT_DEREF, (void *) &deref )
497 != LDAP_OPT_SUCCESS )
499 fprintf( stderr, _("Could not set LDAP_OPT_DEREF %d\n"), deref );
500 exit( EXIT_FAILURE );
502 if (timelimit != -1 &&
503 ldap_set_option( ld, LDAP_OPT_TIMELIMIT, (void *) &timelimit )
504 != LDAP_OPT_SUCCESS )
507 _("Could not set LDAP_OPT_TIMELIMIT %d\n"), timelimit );
508 exit( EXIT_FAILURE );
510 if (sizelimit != -1 &&
511 ldap_set_option( ld, LDAP_OPT_SIZELIMIT, (void *) &sizelimit )
512 != LDAP_OPT_SUCCESS )
515 _("Could not set LDAP_OPT_SIZELIMIT %d\n"), sizelimit );
516 exit( EXIT_FAILURE );
522 main( int argc, char **argv )
524 char *filtpattern, **attrs = NULL, line[BUFSIZ];
528 BerElement *seber = NULL, *vrber = NULL, *prber = NULL;
530 BerElement *syncber = NULL;
531 struct berval *syncbvalp = NULL;
535 #ifdef LDAP_CONTROL_PAGEDRESULTS
536 npagedresponses = npagedentries = npagedreferences =
537 npagedextended = npagedpartial = 0;
540 prog = lutil_progname( "ldapsearch", argc, argv );
542 lutil_log_initialize(argc, argv);
544 if((def_tmpdir = getenv("TMPDIR")) == NULL &&
545 (def_tmpdir = getenv("TMP")) == NULL &&
546 (def_tmpdir = getenv("TEMP")) == NULL )
548 def_tmpdir = LDAP_TMPDIR;
552 def_tmpdir = LDAP_TMPDIR;
554 def_urlpre = malloc( sizeof("file:////") + strlen(def_tmpdir) );
556 if( def_urlpre == NULL ) {
561 sprintf( def_urlpre, "file:///%s/",
562 def_tmpdir[0] == *LDAP_DIRSEP ? &def_tmpdir[1] : def_tmpdir );
564 urlize( def_urlpre );
566 tool_args( argc, argv );
568 if (( argc - optind < 1 ) ||
569 ( *argv[optind] != '(' /*')'*/ &&
570 ( strchr( argv[optind], '=' ) == NULL ) ) )
572 filtpattern = "(objectclass=*)";
574 filtpattern = strdup( argv[optind++] );
577 if ( argv[optind] != NULL ) {
578 attrs = &argv[optind];
581 if ( infile != NULL ) {
582 if ( infile[0] == '-' && infile[1] == '\0' ) {
584 } else if (( fp = fopen( infile, "r" )) == NULL ) {
590 if ( tmpdir == NULL ) {
593 if ( urlpre == NULL )
597 if( urlpre == NULL ) {
598 urlpre = malloc( sizeof("file:////") + strlen(tmpdir) );
600 if( urlpre == NULL ) {
605 sprintf( urlpre, "file:///%s/",
606 tmpdir[0] == *LDAP_DIRSEP ? &tmpdir[1] : tmpdir );
614 ld = tool_conn_setup( 0, &private_conn_setup );
616 if ( pw_file || want_bindpw ) {
618 rc = lutil_get_filed_password( pw_file, &passwd );
619 if( rc ) return EXIT_FAILURE;
621 passwd.bv_val = getpassphrase( _("Enter LDAP Password: ") );
622 passwd.bv_len = passwd.bv_val ? strlen( passwd.bv_val ) : 0;
629 if ( assertion || authzid || manageDSAit || noop
630 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
633 #ifdef LDAP_CONTROL_PAGEDRESULTS
637 || subentries || valuesReturnFilter )
643 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
645 c[i].ldctl_oid = LDAP_CONTROL_X_DOMAIN_SCOPE;
646 c[i].ldctl_value.bv_val = NULL;
647 c[i].ldctl_value.bv_len = 0;
648 c[i].ldctl_iscritical = domainScope > 1;
653 #ifdef LDAP_CONTROL_SUBENTRIES
655 if (( seber = ber_alloc_t(LBER_USE_DER)) == NULL ) {
659 err = ber_printf( seber, "{b}", abs(subentries) == 1 ? 0 : 1 );
661 ber_free( seber, 1 );
662 fprintf( stderr, _("Subentries control encoding error!\n") );
666 if ( ber_flatten2( seber, &c[i].ldctl_value, 0 ) == -1 ) {
670 c[i].ldctl_oid = LDAP_CONTROL_SUBENTRIES;
671 c[i].ldctl_iscritical = subentries < 1;
677 if (( syncber = ber_alloc_t(LBER_USE_DER)) == NULL ) {
681 if ( sync_cookie.bv_len == 0 ) {
682 err = ber_printf( syncber, "{e}", abs(ldapsync) );
684 err = ber_printf( syncber, "{eO}", abs(ldapsync),
688 if ( err == LBER_ERROR ) {
689 ber_free( syncber, 1 );
690 fprintf( stderr, _("ldap sync control encoding error!\n") );
694 if ( ber_flatten( syncber, &syncbvalp ) == LBER_ERROR ) {
698 c[i].ldctl_oid = LDAP_CONTROL_SYNC;
699 c[i].ldctl_value = (*syncbvalp);
700 c[i].ldctl_iscritical = ldapsync < 0;
704 if ( valuesReturnFilter ) {
705 if (( vrber = ber_alloc_t(LBER_USE_DER)) == NULL ) {
709 if ( ( err = ldap_put_vrFilter( vrber, vrFilter ) ) == -1 ) {
710 ber_free( vrber, 1 );
711 fprintf( stderr, _("Bad ValuesReturnFilter: %s\n"), vrFilter );
715 if ( ber_flatten2( vrber, &c[i].ldctl_value, 0 ) == -1 ) {
719 c[i].ldctl_oid = LDAP_CONTROL_VALUESRETURNFILTER;
720 c[i].ldctl_iscritical = valuesReturnFilter > 1;
724 #ifdef LDAP_CONTROL_PAGEDRESULTS
725 if ( pagedResults ) {
726 if (( prber = ber_alloc_t(LBER_USE_DER)) == NULL ) {
730 ber_printf( prber, "{iO}", pageSize, &cookie );
731 if ( ber_flatten2( prber, &c[i].ldctl_value, 0 ) == -1 ) {
735 c[i].ldctl_oid = LDAP_CONTROL_PAGEDRESULTS;
736 c[i].ldctl_iscritical = pagedResults > 1;
741 tool_server_controls( ld, c, i );
743 #ifdef LDAP_CONTROL_SUBENTRIES
744 ber_free( seber, 1 );
746 ber_free( vrber, 1 );
747 #ifdef LDAP_CONTROL_PAGEDRESULTS
748 ber_free( prber, 1 );
753 fprintf( stderr, _("filter%s: %s\nrequesting: "),
754 infile != NULL ? _(" pattern") : "",
757 if ( attrs == NULL ) {
758 fprintf( stderr, _("ALL") );
760 for ( i = 0; attrs[ i ] != NULL; ++i ) {
761 fprintf( stderr, "%s ", attrs[ i ] );
764 fprintf( stderr, "\n" );
768 printf( _("# extended LDIF\n") );
769 } else if ( ldif < 3 ) {
770 printf( _("version: %d\n\n"), 1 );
775 printf(_("# LDAPv%d\n"), protocol);
776 printf(_("# base <%s> with scope %s\n"),
778 ((scope == LDAP_SCOPE_BASE) ? "baseObject"
779 : ((scope == LDAP_SCOPE_ONELEVEL) ? "oneLevel"
780 #ifdef LDAP_SCOPE_SUBORDINATE
781 : ((scope == LDAP_SCOPE_SUBORDINATE) ? "children"
784 #ifdef LDAP_SCOPE_SUBORDINATE
788 printf(_("# filter%s: %s\n"), infile != NULL ? _(" pattern") : "",
790 printf(_("# requesting: "));
792 if ( attrs == NULL ) {
795 for ( i = 0; attrs[ i ] != NULL; ++i ) {
796 printf( "%s ", attrs[ i ] );
801 printf(_("\n# with manageDSAit %scontrol"),
802 manageDSAit > 1 ? _("critical ") : "" );
805 printf(_("\n# with noop %scontrol"),
806 noop > 1 ? _("critical ") : "" );
809 printf(_("\n# with subentries %scontrol: %s"),
810 subentries < 0 ? _("critical ") : "",
811 abs(subentries) == 1 ? "false" : "true" );
813 if ( valuesReturnFilter ) {
814 printf(_("\n# with valuesReturnFilter %scontrol: %s"),
815 valuesReturnFilter > 1 ? _("critical ") : "", vrFilter );
817 #ifdef LDAP_CONTROL_PAGEDRESULTS
819 printf(_("\n# with pagedResults %scontrol: size=%d"),
820 (pagedResults > 1) ? _("critical ") : "",
825 printf( _("\n#\n\n") );
828 if ( infile == NULL ) {
829 rc = dosearch( ld, base, scope, NULL, filtpattern,
830 attrs, attrsonly, NULL, NULL, NULL, -1 );
835 while ( rc == 0 && fgets( line, sizeof( line ), fp ) != NULL ) {
836 line[ strlen( line ) - 1 ] = '\0';
842 rc = dosearch( ld, base, scope, filtpattern, line,
843 attrs, attrsonly, NULL, NULL, NULL, -1 );
850 #ifdef LDAP_CONTROL_PAGEDRESULTS
851 if ( ( rc == LDAP_SUCCESS ) && ( pageSize != 0 ) && ( morePagedResults != 0 ) ) {
853 int i, moreEntries, tmpSize;
855 /* Loop to get the next pages when
856 * enter is pressed on the terminal.
858 if ( pagePrompt != 0 ) {
859 if ( entriesLeft > 0 ) {
860 printf( _("Estimate entries: %d\n"), entriesLeft );
862 printf( _("Press [size] Enter for the next {%d|size} entries.\n"),
865 moreEntries = getchar();
866 while ( moreEntries != EOF && moreEntries != '\n' ) {
867 if ( i < (int)sizeof(buf) - 1 ) {
868 buf[i] = moreEntries;
871 moreEntries = getchar();
875 if ( i > 0 && isdigit( (unsigned char)buf[0] ) ) {
876 int num = sscanf( buf, "%d", &tmpSize );
878 fprintf( stderr, _("Invalid value for PagedResultsControl, %s.\n"), buf);
882 pageSize = (ber_int_t)tmpSize;
890 ldap_unbind_ext( ld, NULL, NULL );
891 #ifdef HAVE_CYRUS_SASL
895 ldap_pvt_tls_destroy();
909 LDAPControl **sctrls,
910 LDAPControl **cctrls,
911 struct timeval *timeout,
921 LDAPMessage *res, *msg;
924 struct berval *retdata = NULL;
925 int nresponses_psearch = -1;
926 int cancel_msgid = -1;
928 if( filtpatt != NULL ) {
929 filter = malloc( strlen( filtpatt ) + strlen( value ) );
930 if( filter == NULL ) {
935 sprintf( filter, filtpatt, value );
938 fprintf( stderr, _("filter: %s\n"), filter );
942 printf( _("#\n# filter: %s\n#\n"), filter );
953 rc = ldap_search_ext( ld, base, scope, filter, attrs, attrsonly,
954 sctrls, cctrls, timeout, sizelimit, &msgid );
956 if ( filtpatt != NULL ) {
960 if( rc != LDAP_SUCCESS ) {
961 fprintf( stderr, _("%s: ldap_search_ext: %s (%d)\n"),
962 prog, ldap_err2string( rc ), rc );
966 nresponses = nentries = nreferences = nextended = npartial = 0;
970 while ((rc = ldap_result( ld, LDAP_RES_ANY,
971 sortattr ? LDAP_MSG_ALL : LDAP_MSG_ONE,
975 (void) ldap_sort_entries( ld, &res,
976 ( *sortattr == '\0' ) ? NULL : sortattr, strcasecmp );
979 for ( msg = ldap_first_message( ld, res );
981 msg = ldap_next_message( ld, msg ) )
983 if ( nresponses++ ) putchar('\n');
984 if ( nresponses_psearch >= 0 )
985 nresponses_psearch++;
987 switch( ldap_msgtype( msg ) ) {
988 case LDAP_RES_SEARCH_ENTRY:
990 print_entry( ld, msg, attrsonly );
993 case LDAP_RES_SEARCH_REFERENCE:
995 print_reference( ld, msg );
998 case LDAP_RES_EXTENDED:
1000 print_extended( ld, msg );
1002 if( ldap_msgid( msg ) == 0 ) {
1003 /* unsolicited extended operation */
1007 if ( cancel_msgid != -1 &&
1008 cancel_msgid == ldap_msgid( msg ) ) {
1009 printf(_("Cancelled \n"));
1010 printf(_("cancel_msgid = %d\n"), cancel_msgid);
1015 case LDAP_RES_SEARCH_RESULT:
1016 rc = print_result( ld, msg, 1 );
1017 #ifdef LDAP_CONTROL_PAGEDRESULTS
1018 if ( pageSize != 0 ) {
1019 rc = parse_page_control( ld, msg, &cookie );
1023 if ( ldapsync == LDAP_SYNC_REFRESH_AND_PERSIST ) {
1029 case LDAP_RES_INTERMEDIATE:
1031 ldap_parse_intermediate( ld, msg,
1032 &retoid, &retdata, NULL, 0 );
1034 nresponses_psearch = 0;
1036 if ( strcmp( retoid, LDAP_SYNC_INFO ) == 0 ) {
1037 printf(_("SyncInfo Received\n"));
1038 ldap_memfree( retoid );
1039 ber_bvfree( retdata );
1043 print_partial( ld, msg );
1044 ldap_memfree( retoid );
1045 ber_bvfree( retdata );
1049 if ( ldapsync && sync_slimit != -1 &&
1050 nresponses_psearch >= sync_slimit ) {
1051 BerElement *msgidber = NULL;
1052 struct berval *msgidvalp = NULL;
1053 msgidber = ber_alloc_t(LBER_USE_DER);
1054 ber_printf(msgidber, "{i}", msgid);
1055 ber_flatten(msgidber, &msgidvalp);
1056 ldap_extended_operation(ld, LDAP_EXOP_X_CANCEL,
1057 msgidvalp, NULL, NULL, &cancel_msgid);
1058 nresponses_psearch = -1;
1062 ldap_msgfree( res );
1066 ldap_perror( ld, "ldap_result" );
1071 ldap_msgfree( res );
1072 #ifdef LDAP_CONTROL_PAGEDRESULTS
1073 if ( pageSize != 0 ) {
1074 npagedresponses = npagedresponses + nresponses;
1075 npagedentries = npagedentries + nentries;
1076 npagedreferences = npagedreferences + nreferences;
1077 npagedextended = npagedextended + nextended;
1078 npagedpartial = npagedpartial + npartial;
1079 if ( ( morePagedResults == 0 ) && ( ldif < 2 ) ) {
1080 printf( _("\n# numResponses: %d\n"), npagedresponses );
1081 if( nentries ) printf( _("# numEntries: %d\n"), npagedentries );
1082 if( nextended ) printf( _("# numExtended: %d\n"), npagedextended );
1083 if( npartial ) printf( _("# numPartial: %d\n"), npagedpartial );
1084 if( nreferences ) printf( _("# numReferences: %d\n"), npagedreferences );
1089 printf( _("\n# numResponses: %d\n"), nresponses );
1090 if( nentries ) printf( _("# numEntries: %d\n"), nentries );
1091 if( nextended ) printf( _("# numExtended: %d\n"), nextended );
1092 if( npartial ) printf( _("# numPartial: %d\n"), npartial );
1093 if( nreferences ) printf( _("# numReferences: %d\n"), nreferences );
1099 /* This is the proposed new way of doing things.
1100 * It is more efficient, but the API is non-standard.
1109 char tmpfname[ 256 ];
1112 BerElement *ber = NULL;
1113 struct berval bv, *bvals, **bvp = &bvals;
1114 LDAPControl **ctrls = NULL;
1117 rc = ldap_get_dn_ber( ld, entry, &ber, &bv );
1120 ufn = ldap_dn2ufn( bv.bv_val );
1121 write_ldif( LDIF_PUT_COMMENT, NULL, ufn, ufn ? strlen( ufn ) : 0 );
1123 write_ldif( LDIF_PUT_VALUE, "dn", bv.bv_val, bv.bv_len );
1125 rc = ldap_get_entry_controls( ld, entry, &ctrls );
1126 if( rc != LDAP_SUCCESS ) {
1127 fprintf(stderr, _("print_entry: %d\n"), rc );
1128 ldap_perror( ld, "ldap_get_entry_controls" );
1129 exit( EXIT_FAILURE );
1133 print_ctrls( ctrls );
1134 ldap_controls_free( ctrls );
1139 ufn = ldap_dn2ufn( bv.bv_val );
1141 write_ldif( LDIF_PUT_VALUE, "ufn", ufn, ufn ? strlen( ufn ) : 0 );
1144 if( ufn != NULL ) ldap_memfree( ufn );
1146 if ( attrsonly ) bvp = NULL;
1148 for ( rc = ldap_get_attribute_ber( ld, entry, ber, &bv, bvp );
1150 rc = ldap_get_attribute_ber( ld, entry, ber, &bv, bvp ) )
1152 if (bv.bv_val == NULL) break;
1155 write_ldif( LDIF_PUT_NOVALUE, bv.bv_val, NULL, 0 );
1157 } else if ( bvals ) {
1158 for ( i = 0; bvals[i].bv_val != NULL; i++ ) {
1159 if ( vals2tmp > 1 || ( vals2tmp &&
1160 ldif_is_not_printable( bvals[i].bv_val, bvals[i].bv_len )))
1163 /* write value to file */
1164 snprintf( tmpfname, sizeof tmpfname,
1165 "%s" LDAP_DIRSEP "ldapsearch-%s-XXXXXX",
1166 tmpdir, bv.bv_val );
1169 tmpfd = mkstemp( tmpfname );
1176 if (( tmpfp = fdopen( tmpfd, "w")) == NULL ) {
1181 if ( fwrite( bvals[ i ].bv_val,
1182 bvals[ i ].bv_len, 1, tmpfp ) == 0 )
1191 snprintf( url, sizeof url, "%s%s", urlpre,
1192 &tmpfname[strlen(tmpdir) + sizeof(LDAP_DIRSEP) - 1] );
1195 write_ldif( LDIF_PUT_URL, bv.bv_val, url, strlen( url ));
1198 write_ldif( LDIF_PUT_VALUE, bv.bv_val,
1199 bvals[ i ].bv_val, bvals[ i ].bv_len );
1202 ber_memfree( bvals );
1211 static void print_reference(
1213 LDAPMessage *reference )
1217 LDAPControl **ctrls;
1220 printf(_("# search reference\n"));
1223 rc = ldap_parse_reference( ld, reference, &refs, &ctrls, 0 );
1225 if( rc != LDAP_SUCCESS ) {
1226 ldap_perror(ld, "ldap_parse_reference");
1227 exit( EXIT_FAILURE );
1232 for( i=0; refs[i] != NULL; i++ ) {
1233 write_ldif( ldif ? LDIF_PUT_COMMENT : LDIF_PUT_VALUE,
1234 "ref", refs[i], strlen(refs[i]) );
1236 ber_memvfree( (void **) refs );
1240 print_ctrls( ctrls );
1241 ldap_controls_free( ctrls );
1245 static void print_extended(
1247 LDAPMessage *extended )
1250 char *retoid = NULL;
1251 struct berval *retdata = NULL;
1254 printf(_("# extended result response\n"));
1257 rc = ldap_parse_extended_result( ld, extended,
1258 &retoid, &retdata, 0 );
1260 if( rc != LDAP_SUCCESS ) {
1261 ldap_perror(ld, "ldap_parse_extended_result");
1262 exit( EXIT_FAILURE );
1266 write_ldif( ldif ? LDIF_PUT_COMMENT : LDIF_PUT_VALUE,
1267 "extended", retoid, retoid ? strlen(retoid) : 0 );
1269 ber_memfree( retoid );
1273 write_ldif( ldif ? LDIF_PUT_COMMENT : LDIF_PUT_BINARY,
1274 "data", retdata->bv_val, retdata->bv_len );
1276 ber_bvfree( retdata );
1279 print_result( ld, extended, 0 );
1282 static void print_partial(
1284 LDAPMessage *partial )
1287 char *retoid = NULL;
1288 struct berval *retdata = NULL;
1289 LDAPControl **ctrls = NULL;
1292 printf(_("# extended partial response\n"));
1295 rc = ldap_parse_intermediate( ld, partial,
1296 &retoid, &retdata, &ctrls, 0 );
1298 if( rc != LDAP_SUCCESS ) {
1299 ldap_perror(ld, "ldap_parse_intermediate");
1300 exit( EXIT_FAILURE );
1304 write_ldif( ldif ? LDIF_PUT_COMMENT : LDIF_PUT_VALUE,
1305 "partial", retoid, retoid ? strlen(retoid) : 0 );
1308 ber_memfree( retoid );
1312 write_ldif( ldif ? LDIF_PUT_COMMENT : LDIF_PUT_BINARY,
1313 "data", retdata->bv_val, retdata->bv_len );
1316 ber_bvfree( retdata );
1320 print_ctrls( ctrls );
1321 ldap_controls_free( ctrls );
1325 static int print_result(
1327 LDAPMessage *result, int search )
1331 char *matcheddn = NULL;
1334 LDAPControl **ctrls = NULL;
1338 printf(_("# search result\n"));
1341 printf("%s: %d\n", _("search"), ldap_msgid(result) );
1345 rc = ldap_parse_result( ld, result,
1346 &err, &matcheddn, &text, &refs, &ctrls, 0 );
1348 if( rc != LDAP_SUCCESS ) {
1349 ldap_perror(ld, "ldap_parse_result");
1350 exit( EXIT_FAILURE );
1355 printf( _("result: %d %s\n"), err, ldap_err2string(err) );
1357 } else if ( err != LDAP_SUCCESS ) {
1358 fprintf( stderr, "%s (%d)\n", ldap_err2string(err), err );
1364 write_ldif( LDIF_PUT_VALUE,
1365 "matchedDN", matcheddn, strlen(matcheddn) );
1367 fprintf( stderr, _("Matched DN: %s\n"), matcheddn );
1371 ber_memfree( matcheddn );
1377 write_ldif( LDIF_PUT_TEXT, "text",
1378 text, strlen(text) );
1380 fprintf( stderr, _("Additional information: %s\n"), text );
1384 ber_memfree( text );
1389 for( i=0; refs[i] != NULL; i++ ) {
1391 write_ldif( LDIF_PUT_VALUE, "ref", refs[i], strlen(refs[i]) );
1393 fprintf( stderr, _("Referral: %s\n"), refs[i] );
1397 ber_memvfree( (void **) refs );
1401 print_ctrls( ctrls );
1402 ldap_controls_free( ctrls );
1408 static void print_ctrls(
1409 LDAPControl **ctrls )
1412 for(i=0; ctrls[i] != NULL; i++ ) {
1413 /* control: OID criticality base64value */
1414 struct berval *b64 = NULL;
1419 len += strlen( ctrls[i]->ldctl_oid );
1421 /* add enough for space after OID and the critical value itself */
1422 len += ctrls[i]->ldctl_iscritical
1423 ? sizeof("true") : sizeof("false");
1425 /* convert to base64 */
1426 if( ctrls[i]->ldctl_value.bv_len ) {
1427 b64 = ber_memalloc( sizeof(struct berval) );
1429 b64->bv_len = LUTIL_BASE64_ENCODE_LEN(
1430 ctrls[i]->ldctl_value.bv_len ) + 1;
1431 b64->bv_val = ber_memalloc( b64->bv_len + 1 );
1433 b64->bv_len = lutil_b64_ntop(
1434 (unsigned char *) ctrls[i]->ldctl_value.bv_val,
1435 ctrls[i]->ldctl_value.bv_len,
1436 b64->bv_val, b64->bv_len );
1440 len += 1 + b64->bv_len;
1443 str = malloc( len + 1 );
1445 strcpy( str, ": " );
1449 strcat( str, ctrls[i]->ldctl_oid );
1450 strcat( str, ctrls[i]->ldctl_iscritical
1451 ? " true" : " false" );
1455 strcat(str, b64->bv_val );
1459 write_ldif( ldif ? LDIF_PUT_COMMENT : LDIF_PUT_VALUE,
1460 "control", str, len );
1469 write_ldif( int type, char *name, char *value, ber_len_t vallen )
1473 if (( ldif = ldif_put( type, name, value, vallen )) == NULL ) {
1477 fputs( ldif, stdout );
1478 ber_memfree( ldif );
1484 #ifdef LDAP_CONTROL_PAGEDRESULTS
1488 LDAPMessage *result,
1489 struct berval *cookie )
1493 LDAPControl **ctrl = NULL;
1494 LDAPControl *ctrlp = NULL;
1497 struct berval servercookie = { 0, NULL };
1499 rc = ldap_parse_result( ld, result,
1500 &err, NULL, NULL, NULL, &ctrl, 0 );
1502 if( rc != LDAP_SUCCESS ) {
1503 ldap_perror(ld, "ldap_parse_result");
1504 exit( EXIT_FAILURE );
1507 if ( err != LDAP_SUCCESS ) {
1508 fprintf( stderr, "%s (%d)\n", ldap_err2string(err), err );
1512 /* Parse the control value
1513 * searchResult ::= SEQUENCE {
1514 * size INTEGER (0..maxInt),
1515 * -- result set size estimate from server - unused
1516 * cookie OCTET STRING
1520 ber = ber_init( &ctrlp->ldctl_value );
1521 if ( ber == NULL ) {
1522 fprintf( stderr, _("Internal error.\n") );
1523 return EXIT_FAILURE;
1526 tag = ber_scanf( ber, "{im}", &entriesLeft, &servercookie );
1527 ber_dupbv( cookie, &servercookie );
1528 (void) ber_free( ber, 1 );
1530 if( tag == LBER_ERROR ) {
1532 _("Paged results response control could not be decoded.\n") );
1533 return EXIT_FAILURE;
1536 if( entriesLeft < 0 ) {
1538 _("Invalid entries estimate in paged results response.\n") );
1539 return EXIT_FAILURE;
1542 if ( servercookie.bv_len == 0 ) {
1543 morePagedResults = 0;
1546 ldap_controls_free( ctrl );
1549 morePagedResults = 0;