1 /* ldapsearch -- a tool for searching LDAP directories */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2006 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>
51 #include <ac/signal.h>
56 #ifdef HAVE_SYS_TYPES_H
57 #include <sys/types.h>
67 #include "lutil_ldap.h"
68 #include "ldap_defaults.h"
76 * NOTE: we use this deprecated function only because
77 * we want ldapsearch to provide some client-side sorting
81 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
82 LDAP_CONST char *left,
83 LDAP_CONST char *right ));
85 LDAP_F( int ) /* deprecated */
86 ldap_sort_entries LDAP_P(( LDAP *ld,
88 LDAP_CONST char *attr,
89 LDAP_SORT_AD_CMP_PROC *cmp ));
92 static int scope = LDAP_SCOPE_SUBTREE;
93 static int deref = -1;
95 static int timelimit = -1;
96 static int sizelimit = -1;
98 static char *def_tmpdir;
99 static char *def_urlpre;
101 #if defined(__CYGWIN__) || defined(__MINGW32__)
102 /* Turn off commandline globbing, otherwise you cannot search for
111 fprintf( stderr, _("usage: %s [options] [filter [attributes...]]\nwhere:\n"), prog);
112 fprintf( stderr, _(" filter\tRFC-2254 compliant LDAP search filter\n"));
113 fprintf( stderr, _(" attributes\twhitespace-separated list of attribute descriptions\n"));
114 fprintf( stderr, _(" which may include:\n"));
115 fprintf( stderr, _(" 1.1 no attributes\n"));
116 fprintf( stderr, _(" * all user attributes\n"));
117 fprintf( stderr, _(" + all operational attributes\n"));
120 fprintf( stderr, _("Search options:\n"));
121 fprintf( stderr, _(" -a deref one of never (default), always, search, or find\n"));
122 fprintf( stderr, _(" -A retrieve attribute names only (no values)\n"));
123 fprintf( stderr, _(" -b basedn base dn for search\n"));
124 fprintf( stderr, _(" -E [!]<ext>[=<extparam>] search extensions (! indicates criticality)\n"));
125 #ifdef LDAP_CONTROL_DONTUSECOPY
126 fprintf( stderr, _(" !dontUseCopy (Don't Use Copy)\n"));
128 fprintf( stderr, _(" [!]domainScope (domain scope)\n"));
129 fprintf( stderr, _(" [!]mv=<filter> (matched values filter)\n"));
130 fprintf( stderr, _(" [!]pr=<size>[/prompt|noprompt] (paged results/prompt)\n"));
131 fprintf( stderr, _(" [!]subentries[=true|false] (subentries)\n"));
132 fprintf( stderr, _(" [!]sync=ro[/<cookie>] (LDAP Sync refreshOnly)\n"));
133 fprintf( stderr, _(" rp[/<cookie>][/<slimit>] (LDAP Sync refreshAndPersist)\n"));
134 fprintf( stderr, _(" [!]<oid>=:<value> (generic control; no response handling)\n"));
135 fprintf( stderr, _(" -F prefix URL prefix for files (default: %s)\n"), def_urlpre);
136 fprintf( stderr, _(" -l limit time limit (in seconds, or \"none\" or \"max\") for search\n"));
137 fprintf( stderr, _(" -L print responses in LDIFv1 format\n"));
138 fprintf( stderr, _(" -LL print responses in LDIF format without comments\n"));
139 fprintf( stderr, _(" -LLL print responses in LDIF format without comments\n"));
140 fprintf( stderr, _(" and version\n"));
141 fprintf( stderr, _(" -s scope one of base, one, sub or children (search scope)\n"));
142 fprintf( stderr, _(" -S attr sort the results by attribute `attr'\n"));
143 fprintf( stderr, _(" -t write binary values to files in temporary directory\n"));
144 fprintf( stderr, _(" -tt write all values to files in temporary directory\n"));
145 fprintf( stderr, _(" -T path write files to directory specified by path (default: %s)\n"), def_tmpdir);
146 fprintf( stderr, _(" -u include User Friendly entry names in the output\n"));
147 fprintf( stderr, _(" -z limit size limit (in entries, or \"none\" or \"max\") for search\n"));
149 exit( EXIT_FAILURE );
152 static void print_entry LDAP_P((
157 static void print_reference(
159 LDAPMessage *reference );
161 static void print_extended(
163 LDAPMessage *extended );
165 static void print_partial(
167 LDAPMessage *partial );
169 static int print_result(
174 static int dosearch LDAP_P((
182 LDAPControl **sctrls,
183 LDAPControl **cctrls,
184 struct timeval *timeout,
187 static char *tmpdir = NULL;
188 static char *urlpre = NULL;
189 static char *base = NULL;
190 static char *sortattr = NULL;
191 static int includeufn, vals2tmp = 0;
193 static int subentries = 0, valuesReturnFilter = 0;
194 static char *vrFilter = NULL;
196 #ifdef LDAP_CONTROL_DONTUSECOPY
197 static int dontUseCopy = 0;
200 static int domainScope = 0;
202 static int ldapsync = 0;
203 static struct berval sync_cookie = { 0, NULL };
204 static int sync_slimit = -1;
206 /* cookie and morePagedResults moved to common.c */
207 static int pagedResults = 0;
208 static int pagePrompt = 1;
209 static ber_int_t pageSize = 0;
210 static ber_int_t entriesLeft = 0;
211 static int npagedresponses;
212 static int npagedentries;
213 static int npagedreferences;
214 static int npagedextended;
215 static int npagedpartial;
217 static LDAPControl *c = NULL;
218 static int nctrls = 0;
219 static int save_nctrls = 0;
227 tmpc = realloc( c, sizeof( LDAPControl ) * nctrls );
228 if ( tmpc == NULL ) {
231 _("unable to make room for control; out of memory?\n"));
244 if (*LDAP_DIRSEP != '/') {
245 for (p = url; *p; p++) {
246 if (*p == *LDAP_DIRSEP)
253 const char options[] = "a:Ab:cE:F:l:Ls:S:tT:uz:"
254 "Cd:D:e:f:h:H:IkKMnO:p:P:QR:U:vVw:WxX:y:Y:Z";
257 handle_private_option( int i )
260 char *control, *cvalue, *next;
262 case 'a': /* set alias deref option */
263 if ( strcasecmp( optarg, "never" ) == 0 ) {
264 deref = LDAP_DEREF_NEVER;
265 } else if ( strncasecmp( optarg, "search", sizeof("search")-1 ) == 0 ) {
266 deref = LDAP_DEREF_SEARCHING;
267 } else if ( strncasecmp( optarg, "find", sizeof("find")-1 ) == 0 ) {
268 deref = LDAP_DEREF_FINDING;
269 } else if ( strcasecmp( optarg, "always" ) == 0 ) {
270 deref = LDAP_DEREF_ALWAYS;
273 _("alias deref should be never, search, find, or always\n") );
277 case 'A': /* retrieve attribute names only -- no values */
280 case 'b': /* search base */
281 base = ber_strdup( optarg );
283 case 'E': /* search extensions */
284 if( protocol == LDAP_VERSION2 ) {
285 fprintf( stderr, _("%s: -E incompatible with LDAPv%d\n"),
287 exit( EXIT_FAILURE );
290 /* should be extended to support comma separated list of
291 * [!]key[=value] parameters, e.g. -E !foo,bar=567
296 if( optarg[0] == '!' ) {
301 control = ber_strdup( optarg );
302 if ( (cvalue = strchr( control, '=' )) != NULL ) {
306 if ( strcasecmp( control, "mv" ) == 0 ) {
307 /* ValuesReturnFilter control */
308 if( valuesReturnFilter ) {
310 _("ValuesReturnFilter previously specified\n"));
311 exit( EXIT_FAILURE );
313 valuesReturnFilter= 1 + crit;
315 if ( cvalue == NULL ) {
317 _("missing filter in ValuesReturnFilter control\n"));
318 exit( EXIT_FAILURE );
322 protocol = LDAP_VERSION3;
324 } else if ( strcasecmp( control, "pr" ) == 0 ) {
326 /* PagedResults control */
327 if ( pagedResults != 0 ) {
329 _("PagedResultsControl previously specified\n") );
330 exit( EXIT_FAILURE );
333 if( cvalue != NULL ) {
336 promptp = strchr( cvalue, '/' );
337 if ( promptp != NULL ) {
339 if ( strcasecmp( promptp, "prompt" ) == 0 ) {
341 } else if ( strcasecmp( promptp, "noprompt" ) == 0) {
345 _("Invalid value for PagedResultsControl,"
346 " %s/%s.\n"), cvalue, promptp );
347 exit( EXIT_FAILURE );
350 num = sscanf( cvalue, "%d", &tmp );
353 _("Invalid value for PagedResultsControl, %s.\n"),
355 exit( EXIT_FAILURE );
358 fprintf(stderr, _("Invalid value for PagedResultsControl.\n"));
359 exit( EXIT_FAILURE );
361 pageSize = (ber_int_t) tmp;
362 pagedResults = 1 + crit;
364 #ifdef LDAP_CONTROL_DONTUSECOPY
365 } else if ( strcasecmp( control, "dontUseCopy" ) == 0 ) {
368 _("dontUseCopy control previously specified\n"));
369 exit( EXIT_FAILURE );
371 if( cvalue != NULL ) {
373 _("dontUseCopy: no control value expected\n") );
378 _("dontUseCopy: critical flag required\n") );
382 dontUseCopy = 1 + crit;
384 } else if ( strcasecmp( control, "domainScope" ) == 0 ) {
387 _("domainScope control previously specified\n"));
388 exit( EXIT_FAILURE );
390 if( cvalue != NULL ) {
392 _("domainScope: no control value expected\n") );
396 domainScope = 1 + crit;
398 } else if ( strcasecmp( control, "subentries" ) == 0 ) {
401 _("subentries control previously specified\n"));
402 exit( EXIT_FAILURE );
404 if( cvalue == NULL || strcasecmp( cvalue, "true") == 0 ) {
406 } else if ( strcasecmp( cvalue, "false") == 0 ) {
410 _("subentries control value \"%s\" invalid\n"),
412 exit( EXIT_FAILURE );
414 if( crit ) subentries *= -1;
416 } else if ( strcasecmp( control, "sync" ) == 0 ) {
420 fprintf( stderr, _("sync control previously specified\n") );
421 exit( EXIT_FAILURE );
423 if ( cvalue == NULL ) {
424 fprintf( stderr, _("missing specification of sync control\n"));
425 exit( EXIT_FAILURE );
427 if ( strncasecmp( cvalue, "ro", 2 ) == 0 ) {
428 ldapsync = LDAP_SYNC_REFRESH_ONLY;
429 cookiep = strchr( cvalue, '/' );
430 if ( cookiep != NULL ) {
432 if ( *cookiep != '\0' ) {
433 ber_str2bv( cookiep, 0, 0, &sync_cookie );
436 } else if ( strncasecmp( cvalue, "rp", 2 ) == 0 ) {
437 ldapsync = LDAP_SYNC_REFRESH_AND_PERSIST;
438 cookiep = strchr( cvalue, '/' );
439 if ( cookiep != NULL ) {
443 slimitp = strchr( cvalue, '/' );
444 if ( slimitp != NULL ) {
447 if ( cookiep != NULL && *cookiep != '\0' )
448 ber_str2bv( cookiep, 0, 0, &sync_cookie );
449 if ( slimitp != NULL && *slimitp != '\0' ) {
450 ival = strtol( slimitp, &next, 10 );
451 if ( next == NULL || next[0] != '\0' ) {
452 fprintf( stderr, _("Unable to parse sync control value \"%s\"\n"), slimitp );
453 exit( EXIT_FAILURE );
458 fprintf( stderr, _("sync control value \"%s\" invalid\n"),
460 exit( EXIT_FAILURE );
462 if ( crit ) ldapsync *= -1;
464 } else if ( tool_is_oid( control ) ) {
466 exit( EXIT_FAILURE );
470 c[ nctrls - 1 ].ldctl_oid = control;
473 if ( cvalue == NULL ) {
474 c[ nctrls - 1 ].ldctl_value.bv_val = NULL;
475 c[ nctrls - 1 ].ldctl_value.bv_len = 0;
477 } else if ( cvalue[ 0 ] == ':' ) {
485 * to use ldif_parse_line2() */
487 ldif_parse_line2( &cvalue[ -2 ], &type,
492 c[ nctrls - 1 ].ldctl_value = value;
495 ber_dupbv( &c[ nctrls - 1 ].ldctl_value, &value );
500 c[ nctrls - 1 ].ldctl_iscritical = crit;
503 fprintf( stderr, _("Invalid search extension name: %s\n"),
508 case 'F': /* uri prefix */
509 if( urlpre ) free( urlpre );
510 urlpre = strdup( optarg );
512 case 'l': /* time limit */
513 if ( strcasecmp( optarg, "none" ) == 0 ) {
516 } else if ( strcasecmp( optarg, "max" ) == 0 ) {
517 timelimit = LDAP_MAXINT;
520 ival = strtol( optarg, &next, 10 );
521 if ( next == NULL || next[0] != '\0' ) {
523 _("Unable to parse time limit \"%s\"\n"), optarg );
524 exit( EXIT_FAILURE );
528 if( timelimit < 0 || timelimit > LDAP_MAXINT ) {
529 fprintf( stderr, _("%s: invalid timelimit (%d) specified\n"),
531 exit( EXIT_FAILURE );
534 case 'L': /* print entries in LDIF format */
537 case 's': /* search scope */
538 if ( strncasecmp( optarg, "base", sizeof("base")-1 ) == 0 ) {
539 scope = LDAP_SCOPE_BASE;
540 } else if ( strncasecmp( optarg, "one", sizeof("one")-1 ) == 0 ) {
541 scope = LDAP_SCOPE_ONELEVEL;
542 } else if (( strcasecmp( optarg, "subordinate" ) == 0 )
543 || ( strcasecmp( optarg, "children" ) == 0 ))
545 scope = LDAP_SCOPE_SUBORDINATE;
546 } else if ( strncasecmp( optarg, "sub", sizeof("sub")-1 ) == 0 ) {
547 scope = LDAP_SCOPE_SUBTREE;
549 fprintf( stderr, _("scope should be base, one, or sub\n") );
553 case 'S': /* sort attribute */
554 sortattr = strdup( optarg );
556 case 't': /* write attribute values to TMPDIR files */
559 case 'T': /* tmpdir */
560 if( tmpdir ) free( tmpdir );
561 tmpdir = strdup( optarg );
563 case 'u': /* include UFN */
566 case 'z': /* size limit */
567 if ( strcasecmp( optarg, "none" ) == 0 ) {
570 } else if ( strcasecmp( optarg, "max" ) == 0 ) {
571 sizelimit = LDAP_MAXINT;
574 ival = strtol( optarg, &next, 10 );
575 if ( next == NULL || next[0] != '\0' ) {
577 _("Unable to parse size limit \"%s\"\n"), optarg );
578 exit( EXIT_FAILURE );
582 if( sizelimit < 0 || sizelimit > LDAP_MAXINT ) {
583 fprintf( stderr, _("%s: invalid sizelimit (%d) specified\n"),
585 exit( EXIT_FAILURE );
596 private_conn_setup( LDAP *ld )
599 ldap_set_option( ld, LDAP_OPT_DEREF, (void *) &deref )
600 != LDAP_OPT_SUCCESS )
602 fprintf( stderr, _("Could not set LDAP_OPT_DEREF %d\n"), deref );
603 exit( EXIT_FAILURE );
606 ldap_set_option( ld, LDAP_OPT_TIMELIMIT, (void *) &timelimit )
607 != LDAP_OPT_SUCCESS )
610 _("Could not set LDAP_OPT_TIMELIMIT %d\n"), timelimit );
611 exit( EXIT_FAILURE );
614 ldap_set_option( ld, LDAP_OPT_SIZELIMIT, (void *) &sizelimit )
615 != LDAP_OPT_SUCCESS )
618 _("Could not set LDAP_OPT_SIZELIMIT %d\n"), sizelimit );
619 exit( EXIT_FAILURE );
624 main( int argc, char **argv )
626 char *filtpattern, **attrs = NULL, line[BUFSIZ];
630 BerElement *seber = NULL, *vrber = NULL, *prber = NULL;
632 BerElement *syncber = NULL;
633 struct berval *syncbvalp = NULL;
635 tool_init( TOOL_SEARCH );
637 npagedresponses = npagedentries = npagedreferences =
638 npagedextended = npagedpartial = 0;
640 prog = lutil_progname( "ldapsearch", argc, argv );
642 if((def_tmpdir = getenv("TMPDIR")) == NULL &&
643 (def_tmpdir = getenv("TMP")) == NULL &&
644 (def_tmpdir = getenv("TEMP")) == NULL )
646 def_tmpdir = LDAP_TMPDIR;
650 def_tmpdir = LDAP_TMPDIR;
652 def_urlpre = malloc( sizeof("file:////") + strlen(def_tmpdir) );
654 if( def_urlpre == NULL ) {
659 sprintf( def_urlpre, "file:///%s/",
660 def_tmpdir[0] == *LDAP_DIRSEP ? &def_tmpdir[1] : def_tmpdir );
662 urlize( def_urlpre );
664 tool_args( argc, argv );
666 if (( argc - optind < 1 ) ||
667 ( *argv[optind] != '(' /*')'*/ &&
668 ( strchr( argv[optind], '=' ) == NULL ) ) )
670 filtpattern = "(objectclass=*)";
672 filtpattern = argv[optind++];
675 if ( argv[optind] != NULL ) {
676 attrs = &argv[optind];
679 if ( infile != NULL ) {
680 if ( infile[0] == '-' && infile[1] == '\0' ) {
682 } else if (( fp = fopen( infile, "r" )) == NULL ) {
688 if ( tmpdir == NULL ) {
691 if ( urlpre == NULL )
695 if( urlpre == NULL ) {
696 urlpre = malloc( sizeof("file:////") + strlen(tmpdir) );
698 if( urlpre == NULL ) {
703 sprintf( urlpre, "file:///%s/",
704 tmpdir[0] == *LDAP_DIRSEP ? &tmpdir[1] : tmpdir );
712 ld = tool_conn_setup( 0, &private_conn_setup );
714 if ( pw_file || want_bindpw ) {
716 rc = lutil_get_filed_password( pw_file, &passwd );
717 if( rc ) return EXIT_FAILURE;
719 passwd.bv_val = getpassphrase( _("Enter LDAP Password: ") );
720 passwd.bv_len = passwd.bv_val ? strlen( passwd.bv_val ) : 0;
727 if ( nctrls > 0 || assertion || authzid || manageDSAit || noop
728 #ifdef LDAP_CONTROL_DONTUSECOPY
731 || domainScope || pagedResults
732 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
734 #endif /* LDAP_CONTROL_X_CHAINING_BEHAVIOR */
736 || subentries || valuesReturnFilter )
740 save_nctrls = nctrls;
742 #ifdef LDAP_CONTROL_DONTUSECOPY
748 c[i].ldctl_oid = LDAP_CONTROL_DONTUSECOPY;
749 c[i].ldctl_value.bv_val = NULL;
750 c[i].ldctl_value.bv_len = 0;
751 c[i].ldctl_iscritical = dontUseCopy > 1;
761 c[i].ldctl_oid = LDAP_CONTROL_X_DOMAIN_SCOPE;
762 c[i].ldctl_value.bv_val = NULL;
763 c[i].ldctl_value.bv_len = 0;
764 c[i].ldctl_iscritical = domainScope > 1;
773 if (( seber = ber_alloc_t(LBER_USE_DER)) == NULL ) {
777 err = ber_printf( seber, "b", abs(subentries) == 1 ? 0 : 1 );
779 ber_free( seber, 1 );
780 fprintf( stderr, _("Subentries control encoding error!\n") );
784 if ( ber_flatten2( seber, &c[i].ldctl_value, 0 ) == -1 ) {
788 c[i].ldctl_oid = LDAP_CONTROL_SUBENTRIES;
789 c[i].ldctl_iscritical = subentries < 1;
798 if (( syncber = ber_alloc_t(LBER_USE_DER)) == NULL ) {
802 if ( sync_cookie.bv_len == 0 ) {
803 err = ber_printf( syncber, "{e}", abs(ldapsync) );
805 err = ber_printf( syncber, "{eO}", abs(ldapsync),
809 if ( err == LBER_ERROR ) {
810 ber_free( syncber, 1 );
811 fprintf( stderr, _("ldap sync control encoding error!\n") );
815 if ( ber_flatten( syncber, &syncbvalp ) == LBER_ERROR ) {
819 c[i].ldctl_oid = LDAP_CONTROL_SYNC;
820 c[i].ldctl_value = (*syncbvalp);
821 c[i].ldctl_iscritical = ldapsync < 0;
825 if ( valuesReturnFilter ) {
830 if (( vrber = ber_alloc_t(LBER_USE_DER)) == NULL ) {
834 if ( ( err = ldap_put_vrFilter( vrber, vrFilter ) ) == -1 ) {
835 ber_free( vrber, 1 );
836 fprintf( stderr, _("Bad ValuesReturnFilter: %s\n"), vrFilter );
840 if ( ber_flatten2( vrber, &c[i].ldctl_value, 0 ) == -1 ) {
844 c[i].ldctl_oid = LDAP_CONTROL_VALUESRETURNFILTER;
845 c[i].ldctl_iscritical = valuesReturnFilter > 1;
849 if ( pagedResults ) {
854 if (( prber = ber_alloc_t(LBER_USE_DER)) == NULL ) {
858 ber_printf( prber, "{iO}", pageSize, &pr_cookie );
859 if ( ber_flatten2( prber, &c[i].ldctl_value, 0 ) == -1 ) {
862 if ( pr_cookie.bv_val != NULL ) {
863 ber_memfree( pr_cookie.bv_val );
864 pr_cookie.bv_val = NULL;
865 pr_cookie.bv_len = 0;
868 c[i].ldctl_oid = LDAP_CONTROL_PAGEDRESULTS;
869 c[i].ldctl_iscritical = pagedResults > 1;
873 tool_server_controls( ld, c, i );
875 /* step back to the original number of controls, so that
876 * those set while parsing args are preserved */
877 nctrls = save_nctrls;
879 ber_free( seber, 1 );
880 ber_free( vrber, 1 );
881 ber_free( prber, 1 );
885 fprintf( stderr, _("filter%s: %s\nrequesting: "),
886 infile != NULL ? _(" pattern") : "",
889 if ( attrs == NULL ) {
890 fprintf( stderr, _("All userApplication attributes") );
892 for ( i = 0; attrs[ i ] != NULL; ++i ) {
893 fprintf( stderr, "%s ", attrs[ i ] );
896 fprintf( stderr, "\n" );
900 printf( _("# extended LDIF\n") );
901 } else if ( ldif < 3 ) {
902 printf( _("version: %d\n\n"), 1 );
907 printf(_("# LDAPv%d\n"), protocol);
908 printf(_("# base <%s> with scope %s\n"),
910 ((scope == LDAP_SCOPE_BASE) ? "baseObject"
911 : ((scope == LDAP_SCOPE_ONELEVEL) ? "oneLevel"
912 : ((scope == LDAP_SCOPE_SUBORDINATE) ? "children"
914 printf(_("# filter%s: %s\n"), infile != NULL ? _(" pattern") : "",
916 printf(_("# requesting: "));
918 if ( attrs == NULL ) {
921 for ( i = 0; attrs[ i ] != NULL; ++i ) {
922 printf( "%s ", attrs[ i ] );
927 printf(_("\n# with manageDSAit %scontrol"),
928 manageDSAit > 1 ? _("critical ") : "" );
931 printf(_("\n# with noop %scontrol"),
932 noop > 1 ? _("critical ") : "" );
935 printf(_("\n# with subentries %scontrol: %s"),
936 subentries < 0 ? _("critical ") : "",
937 abs(subentries) == 1 ? "false" : "true" );
939 if ( valuesReturnFilter ) {
940 printf(_("\n# with valuesReturnFilter %scontrol: %s"),
941 valuesReturnFilter > 1 ? _("critical ") : "", vrFilter );
943 if ( pagedResults ) {
944 printf(_("\n# with pagedResults %scontrol: size=%d"),
945 (pagedResults > 1) ? _("critical ") : "",
949 printf( _("\n#\n\n") );
952 if ( infile == NULL ) {
953 rc = dosearch( ld, base, scope, NULL, filtpattern,
954 attrs, attrsonly, NULL, NULL, NULL, -1 );
959 while ( rc == 0 && fgets( line, sizeof( line ), fp ) != NULL ) {
960 line[ strlen( line ) - 1 ] = '\0';
966 rc = dosearch( ld, base, scope, filtpattern, line,
967 attrs, attrsonly, NULL, NULL, NULL, -1 );
974 if (( rc == LDAP_SUCCESS ) && pageSize && pr_morePagedResults ) {
976 int i, moreEntries, tmpSize;
978 /* Loop to get the next pages when
979 * enter is pressed on the terminal.
981 if ( pagePrompt != 0 ) {
982 if ( entriesLeft > 0 ) {
983 printf( _("Estimate entries: %d\n"), entriesLeft );
985 printf( _("Press [size] Enter for the next {%d|size} entries.\n"),
988 moreEntries = getchar();
989 while ( moreEntries != EOF && moreEntries != '\n' ) {
990 if ( i < (int)sizeof(buf) - 1 ) {
991 buf[i] = moreEntries;
994 moreEntries = getchar();
998 if ( i > 0 && isdigit( (unsigned char)buf[0] ) ) {
999 int num = sscanf( buf, "%d", &tmpSize );
1002 _("Invalid value for PagedResultsControl, %s.\n"), buf);
1003 return EXIT_FAILURE;
1006 pageSize = (ber_int_t)tmpSize;
1017 for ( ; save_nctrls-- > 0; ) {
1018 ber_memfree( c[ save_nctrls ].ldctl_value.bv_val );
1028 static int dosearch(
1036 LDAPControl **sctrls,
1037 LDAPControl **cctrls,
1038 struct timeval *timeout,
1048 LDAPMessage *res, *msg;
1050 char *retoid = NULL;
1051 struct berval *retdata = NULL;
1052 int nresponses_psearch = -1;
1053 int cancel_msgid = -1;
1055 if( filtpatt != NULL ) {
1056 filter = malloc( strlen( filtpatt ) + strlen( value ) );
1057 if( filter == NULL ) {
1059 return EXIT_FAILURE;
1062 sprintf( filter, filtpatt, value );
1065 fprintf( stderr, _("filter: %s\n"), filter );
1069 printf( _("#\n# filter: %s\n#\n"), filter );
1077 return LDAP_SUCCESS;
1080 rc = ldap_search_ext( ld, base, scope, filter, attrs, attrsonly,
1081 sctrls, cctrls, timeout, sizelimit, &msgid );
1083 if ( filtpatt != NULL ) {
1087 if( rc != LDAP_SUCCESS ) {
1088 fprintf( stderr, _("%s: ldap_search_ext: %s (%d)\n"),
1089 prog, ldap_err2string( rc ), rc );
1093 nresponses = nentries = nreferences = nextended = npartial = 0;
1097 while ((rc = ldap_result( ld, LDAP_RES_ANY,
1098 sortattr ? LDAP_MSG_ALL : LDAP_MSG_ONE,
1101 rc = tool_check_abandon( ld, msgid );
1107 (void) ldap_sort_entries( ld, &res,
1108 ( *sortattr == '\0' ) ? NULL : sortattr, strcasecmp );
1111 for ( msg = ldap_first_message( ld, res );
1113 msg = ldap_next_message( ld, msg ) )
1115 if ( nresponses++ ) putchar('\n');
1116 if ( nresponses_psearch >= 0 )
1117 nresponses_psearch++;
1119 switch( ldap_msgtype( msg ) ) {
1120 case LDAP_RES_SEARCH_ENTRY:
1122 print_entry( ld, msg, attrsonly );
1125 case LDAP_RES_SEARCH_REFERENCE:
1127 print_reference( ld, msg );
1130 case LDAP_RES_EXTENDED:
1132 print_extended( ld, msg );
1134 if( ldap_msgid( msg ) == 0 ) {
1135 /* unsolicited extended operation */
1139 if ( cancel_msgid != -1 &&
1140 cancel_msgid == ldap_msgid( msg ) ) {
1141 printf(_("Cancelled \n"));
1142 printf(_("cancel_msgid = %d\n"), cancel_msgid);
1147 case LDAP_RES_SEARCH_RESULT:
1148 /* pagedResults stuff is dealt with
1149 * in tool_print_ctrls(), called by
1150 * print_results(). */
1151 rc = print_result( ld, msg, 1 );
1152 if ( ldapsync == LDAP_SYNC_REFRESH_AND_PERSIST ) {
1158 case LDAP_RES_INTERMEDIATE:
1160 ldap_parse_intermediate( ld, msg,
1161 &retoid, &retdata, NULL, 0 );
1163 nresponses_psearch = 0;
1165 if ( strcmp( retoid, LDAP_SYNC_INFO ) == 0 ) {
1166 printf(_("SyncInfo Received\n"));
1167 ldap_memfree( retoid );
1168 ber_bvfree( retdata );
1172 print_partial( ld, msg );
1173 ldap_memfree( retoid );
1174 ber_bvfree( retdata );
1178 if ( ldapsync && sync_slimit != -1 &&
1179 nresponses_psearch >= sync_slimit ) {
1180 BerElement *msgidber = NULL;
1181 struct berval *msgidvalp = NULL;
1182 msgidber = ber_alloc_t(LBER_USE_DER);
1183 ber_printf(msgidber, "{i}", msgid);
1184 ber_flatten(msgidber, &msgidvalp);
1185 ldap_extended_operation(ld, LDAP_EXOP_X_CANCEL,
1186 msgidvalp, NULL, NULL, &cancel_msgid);
1187 nresponses_psearch = -1;
1191 ldap_msgfree( res );
1196 tool_perror( "ldap_result", rc, NULL, NULL, NULL, NULL );
1200 ldap_msgfree( res );
1202 if ( pagedResults ) {
1203 npagedresponses += nresponses;
1204 npagedentries += nentries;
1205 npagedextended += nextended;
1206 npagedpartial += npartial;
1207 npagedreferences += nreferences;
1208 if ( ( pr_morePagedResults == 0 ) && ( ldif < 2 ) ) {
1209 printf( _("\n# numResponses: %d\n"), npagedresponses );
1210 if( npagedentries ) {
1211 printf( _("# numEntries: %d\n"), npagedentries );
1213 if( npagedextended ) {
1214 printf( _("# numExtended: %d\n"), npagedextended );
1216 if( npagedpartial ) {
1217 printf( _("# numPartial: %d\n"), npagedpartial );
1219 if( npagedreferences ) {
1220 printf( _("# numReferences: %d\n"), npagedreferences );
1223 } else if ( ldif < 2 ) {
1224 printf( _("\n# numResponses: %d\n"), nresponses );
1225 if( nentries ) printf( _("# numEntries: %d\n"), nentries );
1226 if( nextended ) printf( _("# numExtended: %d\n"), nextended );
1227 if( npartial ) printf( _("# numPartial: %d\n"), npartial );
1228 if( nreferences ) printf( _("# numReferences: %d\n"), nreferences );
1234 /* This is the proposed new way of doing things.
1235 * It is more efficient, but the API is non-standard.
1244 char tmpfname[ 256 ];
1247 BerElement *ber = NULL;
1248 struct berval bv, *bvals, **bvp = &bvals;
1249 LDAPControl **ctrls = NULL;
1252 rc = ldap_get_dn_ber( ld, entry, &ber, &bv );
1255 ufn = ldap_dn2ufn( bv.bv_val );
1256 tool_write_ldif( LDIF_PUT_COMMENT, NULL, ufn, ufn ? strlen( ufn ) : 0 );
1258 tool_write_ldif( LDIF_PUT_VALUE, "dn", bv.bv_val, bv.bv_len );
1260 rc = ldap_get_entry_controls( ld, entry, &ctrls );
1261 if( rc != LDAP_SUCCESS ) {
1262 fprintf(stderr, _("print_entry: %d\n"), rc );
1263 tool_perror( "ldap_get_entry_controls", rc, NULL, NULL, NULL, NULL );
1264 exit( EXIT_FAILURE );
1268 tool_print_ctrls( ld, ctrls );
1269 ldap_controls_free( ctrls );
1274 ufn = ldap_dn2ufn( bv.bv_val );
1276 tool_write_ldif( LDIF_PUT_VALUE, "ufn", ufn, ufn ? strlen( ufn ) : 0 );
1279 if( ufn != NULL ) ldap_memfree( ufn );
1281 if ( attrsonly ) bvp = NULL;
1283 for ( rc = ldap_get_attribute_ber( ld, entry, ber, &bv, bvp );
1285 rc = ldap_get_attribute_ber( ld, entry, ber, &bv, bvp ) )
1287 if (bv.bv_val == NULL) break;
1290 tool_write_ldif( LDIF_PUT_NOVALUE, bv.bv_val, NULL, 0 );
1292 } else if ( bvals ) {
1293 for ( i = 0; bvals[i].bv_val != NULL; i++ ) {
1294 if ( vals2tmp > 1 || ( vals2tmp &&
1295 ldif_is_not_printable( bvals[i].bv_val, bvals[i].bv_len )))
1298 /* write value to file */
1299 snprintf( tmpfname, sizeof tmpfname,
1300 "%s" LDAP_DIRSEP "ldapsearch-%s-XXXXXX",
1301 tmpdir, bv.bv_val );
1304 tmpfd = mkstemp( tmpfname );
1311 if (( tmpfp = fdopen( tmpfd, "w")) == NULL ) {
1316 if ( fwrite( bvals[ i ].bv_val,
1317 bvals[ i ].bv_len, 1, tmpfp ) == 0 )
1326 snprintf( url, sizeof url, "%s%s", urlpre,
1327 &tmpfname[strlen(tmpdir) + sizeof(LDAP_DIRSEP) - 1] );
1330 tool_write_ldif( LDIF_PUT_URL, bv.bv_val, url, strlen( url ));
1333 tool_write_ldif( LDIF_PUT_VALUE, bv.bv_val,
1334 bvals[ i ].bv_val, bvals[ i ].bv_len );
1337 ber_memfree( bvals );
1346 static void print_reference(
1348 LDAPMessage *reference )
1352 LDAPControl **ctrls;
1355 printf(_("# search reference\n"));
1358 rc = ldap_parse_reference( ld, reference, &refs, &ctrls, 0 );
1360 if( rc != LDAP_SUCCESS ) {
1361 tool_perror( "ldap_parse_reference", rc, NULL, NULL, NULL, NULL );
1362 exit( EXIT_FAILURE );
1367 for( i=0; refs[i] != NULL; i++ ) {
1368 tool_write_ldif( ldif ? LDIF_PUT_COMMENT : LDIF_PUT_VALUE,
1369 "ref", refs[i], strlen(refs[i]) );
1371 ber_memvfree( (void **) refs );
1375 tool_print_ctrls( ld, ctrls );
1376 ldap_controls_free( ctrls );
1380 static void print_extended(
1382 LDAPMessage *extended )
1385 char *retoid = NULL;
1386 struct berval *retdata = NULL;
1389 printf(_("# extended result response\n"));
1392 rc = ldap_parse_extended_result( ld, extended,
1393 &retoid, &retdata, 0 );
1395 if( rc != LDAP_SUCCESS ) {
1396 tool_perror( "ldap_parse_extended_result", rc, NULL, NULL, NULL, NULL );
1397 exit( EXIT_FAILURE );
1401 tool_write_ldif( ldif ? LDIF_PUT_COMMENT : LDIF_PUT_VALUE,
1402 "extended", retoid, retoid ? strlen(retoid) : 0 );
1404 ber_memfree( retoid );
1408 tool_write_ldif( ldif ? LDIF_PUT_COMMENT : LDIF_PUT_BINARY,
1409 "data", retdata->bv_val, retdata->bv_len );
1411 ber_bvfree( retdata );
1414 print_result( ld, extended, 0 );
1417 static void print_partial(
1419 LDAPMessage *partial )
1422 char *retoid = NULL;
1423 struct berval *retdata = NULL;
1424 LDAPControl **ctrls = NULL;
1427 printf(_("# extended partial response\n"));
1430 rc = ldap_parse_intermediate( ld, partial,
1431 &retoid, &retdata, &ctrls, 0 );
1433 if( rc != LDAP_SUCCESS ) {
1434 tool_perror( "ldap_parse_intermediate", rc, NULL, NULL, NULL, NULL );
1435 exit( EXIT_FAILURE );
1439 tool_write_ldif( ldif ? LDIF_PUT_COMMENT : LDIF_PUT_VALUE,
1440 "partial", retoid, retoid ? strlen(retoid) : 0 );
1443 ber_memfree( retoid );
1447 tool_write_ldif( ldif ? LDIF_PUT_COMMENT : LDIF_PUT_BINARY,
1448 "data", retdata->bv_val, retdata->bv_len );
1451 ber_bvfree( retdata );
1455 tool_print_ctrls( ld, ctrls );
1456 ldap_controls_free( ctrls );
1460 static int print_result(
1462 LDAPMessage *result, int search )
1466 char *matcheddn = NULL;
1469 LDAPControl **ctrls = NULL;
1473 printf(_("# search result\n"));
1476 printf("%s: %d\n", _("search"), ldap_msgid(result) );
1480 rc = ldap_parse_result( ld, result,
1481 &err, &matcheddn, &text, &refs, &ctrls, 0 );
1483 if( rc != LDAP_SUCCESS ) {
1484 tool_perror( "ldap_parse_result", rc, NULL, NULL, NULL, NULL );
1485 exit( EXIT_FAILURE );
1490 printf( _("result: %d %s\n"), err, ldap_err2string(err) );
1492 } else if ( err != LDAP_SUCCESS ) {
1493 fprintf( stderr, "%s (%d)\n", ldap_err2string(err), err );
1499 tool_write_ldif( LDIF_PUT_VALUE,
1500 "matchedDN", matcheddn, strlen(matcheddn) );
1502 fprintf( stderr, _("Matched DN: %s\n"), matcheddn );
1506 ber_memfree( matcheddn );
1512 tool_write_ldif( LDIF_PUT_TEXT, "text",
1513 text, strlen(text) );
1515 fprintf( stderr, _("Additional information: %s\n"), text );
1519 ber_memfree( text );
1524 for( i=0; refs[i] != NULL; i++ ) {
1526 tool_write_ldif( LDIF_PUT_VALUE, "ref", refs[i], strlen(refs[i]) );
1528 fprintf( stderr, _("Referral: %s\n"), refs[i] );
1532 ber_memvfree( (void **) refs );
1535 pr_morePagedResults = 0;
1538 tool_print_ctrls( ld, ctrls );
1539 ldap_controls_free( ctrls );