1 /* ldapsearch -- a tool for searching LDAP directories */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2010 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;
100 static char *def_tmpdir;
101 static char *def_urlpre;
103 #if defined(__CYGWIN__) || defined(__MINGW32__)
104 /* Turn off commandline globbing, otherwise you cannot search for
113 fprintf( stderr, _("usage: %s [options] [filter [attributes...]]\nwhere:\n"), prog);
114 fprintf( stderr, _(" filter\tRFC 4515 compliant LDAP search filter\n"));
115 fprintf( stderr, _(" attributes\twhitespace-separated list of attribute descriptions\n"));
116 fprintf( stderr, _(" which may include:\n"));
117 fprintf( stderr, _(" 1.1 no attributes\n"));
118 fprintf( stderr, _(" * all user attributes\n"));
119 fprintf( stderr, _(" + all operational attributes\n"));
122 fprintf( stderr, _("Search options:\n"));
123 fprintf( stderr, _(" -a deref one of never (default), always, search, or find\n"));
124 fprintf( stderr, _(" -A retrieve attribute names only (no values)\n"));
125 fprintf( stderr, _(" -b basedn base dn for search\n"));
126 fprintf( stderr, _(" -c continuous operation mode (do not stop on errors)\n"));
127 fprintf( stderr, _(" -E [!]<ext>[=<extparam>] search extensions (! indicates criticality)\n"));
128 fprintf( stderr, _(" [!]domainScope (domain scope)\n"));
129 fprintf( stderr, _(" !dontUseCopy (Don't Use Copy)\n"));
130 fprintf( stderr, _(" [!]mv=<filter> (RFC 3876 matched values filter)\n"));
131 fprintf( stderr, _(" [!]pr=<size>[/prompt|noprompt] (RFC 2696 paged results/prompt)\n"));
132 fprintf( stderr, _(" [!]sss=[-]<attr[:OID]>[/[-]<attr[:OID]>...]\n"));
133 fprintf( stderr, _(" (RFC 2891 server side sorting)\n"));
134 fprintf( stderr, _(" [!]subentries[=true|false] (RFC 3672 subentries)\n"));
135 fprintf( stderr, _(" [!]sync=ro[/<cookie>] (RFC 4533 LDAP Sync refreshOnly)\n"));
136 fprintf( stderr, _(" rp[/<cookie>][/<slimit>] (refreshAndPersist)\n"));
137 fprintf( stderr, _(" [!]vlv=<before>/<after>(/<offset>/<count>|:<value>)\n"));
138 fprintf( stderr, _(" (ldapv3-vlv-09 virtual list views)\n"));
139 #ifdef LDAP_CONTROL_X_DEREF
140 fprintf( stderr, _(" [!]deref=derefAttr:attr[,...][;derefAttr:attr[,...][;...]]\n"));
142 fprintf( stderr, _(" [!]<oid>=:<value> (generic control; no response handling)\n"));
143 fprintf( stderr, _(" -f file read operations from `file'\n"));
144 fprintf( stderr, _(" -F prefix URL prefix for files (default: %s)\n"), def_urlpre);
145 fprintf( stderr, _(" -l limit time limit (in seconds, or \"none\" or \"max\") for search\n"));
146 fprintf( stderr, _(" -L print responses in LDIFv1 format\n"));
147 fprintf( stderr, _(" -LL print responses in LDIF format without comments\n"));
148 fprintf( stderr, _(" -LLL print responses in LDIF format without comments\n"));
149 fprintf( stderr, _(" and version\n"));
150 fprintf( stderr, _(" -M enable Manage DSA IT control (-MM to make critical)\n"));
151 fprintf( stderr, _(" -P version protocol version (default: 3)\n"));
152 fprintf( stderr, _(" -s scope one of base, one, sub or children (search scope)\n"));
153 fprintf( stderr, _(" -S attr sort the results by attribute `attr'\n"));
154 fprintf( stderr, _(" -t write binary values to files in temporary directory\n"));
155 fprintf( stderr, _(" -tt write all values to files in temporary directory\n"));
156 fprintf( stderr, _(" -T path write files to directory specified by path (default: %s)\n"), def_tmpdir);
157 fprintf( stderr, _(" -u include User Friendly entry names in the output\n"));
158 fprintf( stderr, _(" -z limit size limit (in entries, or \"none\" or \"max\") for search\n"));
160 exit( EXIT_FAILURE );
163 static void print_entry LDAP_P((
168 static void print_reference(
170 LDAPMessage *reference );
172 static void print_extended(
174 LDAPMessage *extended );
176 static void print_partial(
178 LDAPMessage *partial );
180 static int print_result(
185 static int dosearch LDAP_P((
193 LDAPControl **sctrls,
194 LDAPControl **cctrls,
195 struct timeval *timeout,
198 static char *tmpdir = NULL;
199 static char *urlpre = NULL;
200 static char *base = NULL;
201 static char *sortattr = NULL;
202 static int includeufn, vals2tmp = 0;
204 static int subentries = 0, valuesReturnFilter = 0;
205 static char *vrFilter = NULL;
207 #ifdef LDAP_CONTROL_DONTUSECOPY
208 static int dontUseCopy = 0;
211 static int domainScope = 0;
214 static LDAPSortKey **sss_keys = NULL;
217 static LDAPVLVInfo vlvInfo;
218 static struct berval vlvValue;
220 static int ldapsync = 0;
221 static struct berval sync_cookie = { 0, NULL };
222 static int sync_slimit = -1;
224 /* cookie and morePagedResults moved to common.c */
225 static int pagedResults = 0;
226 static int pagePrompt = 1;
227 static ber_int_t pageSize = 0;
228 static ber_int_t entriesLeft = 0;
229 static int npagedresponses;
230 static int npagedentries;
231 static int npagedreferences;
232 static int npagedextended;
233 static int npagedpartial;
235 static LDAPControl *c = NULL;
236 static int nctrls = 0;
237 static int save_nctrls = 0;
239 #ifdef LDAP_CONTROL_X_DEREF
240 static int derefcrit;
241 static LDAPDerefSpec *ds;
242 static struct berval derefval;
251 tmpc = realloc( c, sizeof( LDAPControl ) * nctrls );
252 if ( tmpc == NULL ) {
255 _("unable to make room for control; out of memory?\n"));
268 if (*LDAP_DIRSEP != '/') {
269 for (p = url; *p; p++) {
270 if (*p == *LDAP_DIRSEP)
277 parse_vlv(char *cvalue)
283 if ( sscanf( keyp, "%d/%d", &num1, &num2 ) != 2 ) {
285 _("VLV control value \"%s\" invalid\n"),
289 vlvInfo.ldvlv_before_count = num1;
290 vlvInfo.ldvlv_after_count = num2;
291 keyp = strchr( keyp, '/' ) + 1;
292 key2 = strchr( keyp, '/' );
295 if ( sscanf( keyp, "%d/%d", &num1, &num2 ) != 2 ) {
297 _("VLV control value \"%s\" invalid\n"),
301 vlvInfo.ldvlv_offset = num1;
302 vlvInfo.ldvlv_count = num2;
303 vlvInfo.ldvlv_attrvalue = NULL;
305 key2 = strchr( keyp, ':' );
308 _("VLV control value \"%s\" invalid\n"),
312 ber_str2bv( key2+1, 0, 0, &vlvValue );
313 vlvInfo.ldvlv_attrvalue = &vlvValue;
318 const char options[] = "a:Ab:cE:F:l:Ls:S:tT:uz:"
319 "Cd:D:e:f:h:H:IMnNO:o:p:P:QR:U:vVw:WxX:y:Y:Z";
322 handle_private_option( int i )
327 case 'a': /* set alias deref option */
328 if ( strcasecmp( optarg, "never" ) == 0 ) {
329 deref = LDAP_DEREF_NEVER;
330 } else if ( strncasecmp( optarg, "search", sizeof("search")-1 ) == 0 ) {
331 deref = LDAP_DEREF_SEARCHING;
332 } else if ( strncasecmp( optarg, "find", sizeof("find")-1 ) == 0 ) {
333 deref = LDAP_DEREF_FINDING;
334 } else if ( strcasecmp( optarg, "always" ) == 0 ) {
335 deref = LDAP_DEREF_ALWAYS;
338 _("alias deref should be never, search, find, or always\n") );
342 case 'A': /* retrieve attribute names only -- no values */
345 case 'b': /* search base */
346 base = ber_strdup( optarg );
348 case 'E': /* search extensions */
349 if( protocol == LDAP_VERSION2 ) {
350 fprintf( stderr, _("%s: -E incompatible with LDAPv%d\n"),
352 exit( EXIT_FAILURE );
355 /* should be extended to support comma separated list of
356 * [!]key[=value] parameters, e.g. -E !foo,bar=567
361 if( optarg[0] == '!' ) {
366 control = ber_strdup( optarg );
367 if ( (cvalue = strchr( control, '=' )) != NULL ) {
371 if ( strcasecmp( control, "mv" ) == 0 ) {
372 /* ValuesReturnFilter control */
373 if( valuesReturnFilter ) {
375 _("ValuesReturnFilter previously specified\n"));
376 exit( EXIT_FAILURE );
378 valuesReturnFilter= 1 + crit;
380 if ( cvalue == NULL ) {
382 _("missing filter in ValuesReturnFilter control\n"));
383 exit( EXIT_FAILURE );
387 protocol = LDAP_VERSION3;
389 } else if ( strcasecmp( control, "pr" ) == 0 ) {
391 /* PagedResults control */
392 if ( pagedResults != 0 ) {
394 _("PagedResultsControl previously specified\n") );
395 exit( EXIT_FAILURE );
399 _("PagedResultsControl incompatible with VLV\n") );
400 exit( EXIT_FAILURE );
403 if( cvalue != NULL ) {
406 promptp = strchr( cvalue, '/' );
407 if ( promptp != NULL ) {
409 if ( strcasecmp( promptp, "prompt" ) == 0 ) {
411 } else if ( strcasecmp( promptp, "noprompt" ) == 0) {
415 _("Invalid value for PagedResultsControl,"
416 " %s/%s.\n"), cvalue, promptp );
417 exit( EXIT_FAILURE );
420 num = sscanf( cvalue, "%d", &tmp );
423 _("Invalid value for PagedResultsControl, %s.\n"),
425 exit( EXIT_FAILURE );
428 fprintf(stderr, _("Invalid value for PagedResultsControl.\n"));
429 exit( EXIT_FAILURE );
431 pageSize = (ber_int_t) tmp;
432 pagedResults = 1 + crit;
434 #ifdef LDAP_CONTROL_DONTUSECOPY
435 } else if ( strcasecmp( control, "dontUseCopy" ) == 0 ) {
438 _("dontUseCopy control previously specified\n"));
439 exit( EXIT_FAILURE );
441 if( cvalue != NULL ) {
443 _("dontUseCopy: no control value expected\n") );
448 _("dontUseCopy: critical flag required\n") );
452 dontUseCopy = 1 + crit;
454 } else if ( strcasecmp( control, "domainScope" ) == 0 ) {
457 _("domainScope control previously specified\n"));
458 exit( EXIT_FAILURE );
460 if( cvalue != NULL ) {
462 _("domainScope: no control value expected\n") );
466 domainScope = 1 + crit;
468 } else if ( strcasecmp( control, "sss" ) == 0 ) {
472 _("server side sorting control previously specified\n"));
473 exit( EXIT_FAILURE );
475 if( cvalue == NULL ) {
477 _("missing specification of sss control\n") );
478 exit( EXIT_FAILURE );
481 while ( ( keyp = strchr(keyp, '/') ) != NULL ) {
484 if ( ldap_create_sort_keylist( &sss_keys, cvalue )) {
486 _("server side sorting control value \"%s\" invalid\n"),
488 exit( EXIT_FAILURE );
493 } else if ( strcasecmp( control, "subentries" ) == 0 ) {
496 _("subentries control previously specified\n"));
497 exit( EXIT_FAILURE );
499 if( cvalue == NULL || strcasecmp( cvalue, "true") == 0 ) {
501 } else if ( strcasecmp( cvalue, "false") == 0 ) {
505 _("subentries control value \"%s\" invalid\n"),
507 exit( EXIT_FAILURE );
509 if( crit ) subentries *= -1;
511 } else if ( strcasecmp( control, "sync" ) == 0 ) {
515 fprintf( stderr, _("sync control previously specified\n") );
516 exit( EXIT_FAILURE );
518 if ( cvalue == NULL ) {
519 fprintf( stderr, _("missing specification of sync control\n"));
520 exit( EXIT_FAILURE );
522 if ( strncasecmp( cvalue, "ro", 2 ) == 0 ) {
523 ldapsync = LDAP_SYNC_REFRESH_ONLY;
524 cookiep = strchr( cvalue, '/' );
525 if ( cookiep != NULL ) {
527 if ( *cookiep != '\0' ) {
528 ber_str2bv( cookiep, 0, 0, &sync_cookie );
531 } else if ( strncasecmp( cvalue, "rp", 2 ) == 0 ) {
532 ldapsync = LDAP_SYNC_REFRESH_AND_PERSIST;
533 cookiep = strchr( cvalue, '/' );
534 if ( cookiep != NULL ) {
538 slimitp = strchr( cvalue, '/' );
539 if ( slimitp != NULL ) {
542 if ( cookiep != NULL && *cookiep != '\0' )
543 ber_str2bv( cookiep, 0, 0, &sync_cookie );
544 if ( slimitp != NULL && *slimitp != '\0' ) {
545 ival = strtol( slimitp, &next, 10 );
546 if ( next == NULL || next[0] != '\0' ) {
547 fprintf( stderr, _("Unable to parse sync control value \"%s\"\n"), slimitp );
548 exit( EXIT_FAILURE );
553 fprintf( stderr, _("sync control value \"%s\" invalid\n"),
555 exit( EXIT_FAILURE );
557 if ( crit ) ldapsync *= -1;
559 } else if ( strcasecmp( control, "vlv" ) == 0 ) {
562 _("virtual list view control previously specified\n"));
563 exit( EXIT_FAILURE );
565 if ( pagedResults != 0 ) {
567 _("PagedResultsControl incompatible with VLV\n") );
568 exit( EXIT_FAILURE );
570 if( cvalue == NULL ) {
572 _("missing specification of vlv control\n") );
573 exit( EXIT_FAILURE );
575 if ( parse_vlv( cvalue ))
576 exit( EXIT_FAILURE );
580 #ifdef LDAP_CONTROL_X_DEREF
581 } else if ( strcasecmp( control, "deref" ) == 0 ) {
585 /* cvalue is something like
587 * derefAttr:attr[,attr[...]][;derefAttr:attr[,attr[...]]]"
590 specs = ldap_str2charray( cvalue, ";" );
591 if ( specs == NULL ) {
592 fprintf( stderr, _("deref specs \"%s\" invalid\n"),
594 exit( EXIT_FAILURE );
596 for ( ispecs = 0; specs[ ispecs ] != NULL; ispecs++ )
599 ds = ldap_memcalloc( ispecs + 1, sizeof( LDAPDerefSpec ) );
602 exit( EXIT_FAILURE );
605 for ( ispecs = 0; specs[ ispecs ] != NULL; ispecs++ ) {
608 ptr = strchr( specs[ ispecs ], ':' );
610 fprintf( stderr, _("deref specs \"%s\" invalid\n"),
612 exit( EXIT_FAILURE );
615 ds[ ispecs ].derefAttr = specs[ ispecs ];
617 ds[ ispecs ].attributes = ldap_str2charray( ptr, "," );
620 derefcrit = 1 + crit;
622 ldap_memfree( specs );
623 #endif /* LDAP_CONTROL_X_DEREF */
625 } else if ( tool_is_oid( control ) ) {
627 exit( EXIT_FAILURE );
631 c[ nctrls - 1 ].ldctl_oid = control;
634 if ( cvalue == NULL ) {
635 c[ nctrls - 1 ].ldctl_value.bv_val = NULL;
636 c[ nctrls - 1 ].ldctl_value.bv_len = 0;
638 } else if ( cvalue[ 0 ] == ':' ) {
646 * to use ldif_parse_line2() */
648 ldif_parse_line2( &cvalue[ -2 ], &type,
653 c[ nctrls - 1 ].ldctl_value = value;
656 ber_dupbv( &c[ nctrls - 1 ].ldctl_value, &value );
661 c[ nctrls - 1 ].ldctl_iscritical = crit;
664 fprintf( stderr, _("Invalid search extension name: %s\n"),
669 case 'F': /* uri prefix */
670 if( urlpre ) free( urlpre );
671 urlpre = strdup( optarg );
673 case 'l': /* time limit */
674 if ( strcasecmp( optarg, "none" ) == 0 ) {
677 } else if ( strcasecmp( optarg, "max" ) == 0 ) {
678 timelimit = LDAP_MAXINT;
681 ival = strtol( optarg, &next, 10 );
682 if ( next == NULL || next[0] != '\0' ) {
684 _("Unable to parse time limit \"%s\"\n"), optarg );
685 exit( EXIT_FAILURE );
689 if( timelimit < 0 || timelimit > LDAP_MAXINT ) {
690 fprintf( stderr, _("%s: invalid timelimit (%d) specified\n"),
692 exit( EXIT_FAILURE );
695 case 'L': /* print entries in LDIF format */
698 case 's': /* search scope */
699 if ( strncasecmp( optarg, "base", sizeof("base")-1 ) == 0 ) {
700 scope = LDAP_SCOPE_BASE;
701 } else if ( strncasecmp( optarg, "one", sizeof("one")-1 ) == 0 ) {
702 scope = LDAP_SCOPE_ONELEVEL;
703 } else if (( strcasecmp( optarg, "subordinate" ) == 0 )
704 || ( strcasecmp( optarg, "children" ) == 0 ))
706 scope = LDAP_SCOPE_SUBORDINATE;
707 } else if ( strncasecmp( optarg, "sub", sizeof("sub")-1 ) == 0 ) {
708 scope = LDAP_SCOPE_SUBTREE;
710 fprintf( stderr, _("scope should be base, one, or sub\n") );
714 case 'S': /* sort attribute */
715 sortattr = strdup( optarg );
717 case 't': /* write attribute values to TMPDIR files */
720 case 'T': /* tmpdir */
721 if( tmpdir ) free( tmpdir );
722 tmpdir = strdup( optarg );
724 case 'u': /* include UFN */
727 case 'z': /* size limit */
728 if ( strcasecmp( optarg, "none" ) == 0 ) {
731 } else if ( strcasecmp( optarg, "max" ) == 0 ) {
732 sizelimit = LDAP_MAXINT;
735 ival = strtol( optarg, &next, 10 );
736 if ( next == NULL || next[0] != '\0' ) {
738 _("Unable to parse size limit \"%s\"\n"), optarg );
739 exit( EXIT_FAILURE );
743 if( sizelimit < 0 || sizelimit > LDAP_MAXINT ) {
744 fprintf( stderr, _("%s: invalid sizelimit (%d) specified\n"),
746 exit( EXIT_FAILURE );
757 private_conn_setup( LDAP *ld )
760 ldap_set_option( ld, LDAP_OPT_DEREF, (void *) &deref )
761 != LDAP_OPT_SUCCESS )
763 fprintf( stderr, _("Could not set LDAP_OPT_DEREF %d\n"), deref );
764 exit( EXIT_FAILURE );
767 ldap_set_option( ld, LDAP_OPT_TIMELIMIT, (void *) &timelimit )
768 != LDAP_OPT_SUCCESS )
771 _("Could not set LDAP_OPT_TIMELIMIT %d\n"), timelimit );
772 exit( EXIT_FAILURE );
775 ldap_set_option( ld, LDAP_OPT_SIZELIMIT, (void *) &sizelimit )
776 != LDAP_OPT_SUCCESS )
779 _("Could not set LDAP_OPT_SIZELIMIT %d\n"), sizelimit );
780 exit( EXIT_FAILURE );
785 main( int argc, char **argv )
787 char *filtpattern, **attrs = NULL, line[BUFSIZ];
789 int rc, rc1, i, first;
791 BerElement *seber = NULL, *vrber = NULL;
793 BerElement *syncber = NULL;
794 struct berval *syncbvalp = NULL;
797 tool_init( TOOL_SEARCH );
799 npagedresponses = npagedentries = npagedreferences =
800 npagedextended = npagedpartial = 0;
802 prog = lutil_progname( "ldapsearch", argc, argv );
804 if((def_tmpdir = getenv("TMPDIR")) == NULL &&
805 (def_tmpdir = getenv("TMP")) == NULL &&
806 (def_tmpdir = getenv("TEMP")) == NULL )
808 def_tmpdir = LDAP_TMPDIR;
812 def_tmpdir = LDAP_TMPDIR;
814 def_urlpre = malloc( sizeof("file:////") + strlen(def_tmpdir) );
816 if( def_urlpre == NULL ) {
821 sprintf( def_urlpre, "file:///%s/",
822 def_tmpdir[0] == *LDAP_DIRSEP ? &def_tmpdir[1] : def_tmpdir );
824 urlize( def_urlpre );
826 tool_args( argc, argv );
830 _("VLV control requires server side sort control\n" ));
834 if (( argc - optind < 1 ) ||
835 ( *argv[optind] != '(' /*')'*/ &&
836 ( strchr( argv[optind], '=' ) == NULL ) ) )
838 filtpattern = "(objectclass=*)";
840 filtpattern = argv[optind++];
843 if ( argv[optind] != NULL ) {
844 attrs = &argv[optind];
847 if ( infile != NULL ) {
850 if ( infile[0] == '-' && infile[1] == '\0' ) {
852 } else if (( fp = fopen( infile, "r" )) == NULL ) {
857 for( i=0 ; filtpattern[i] ; i++ ) {
858 if( filtpattern[i] == '%' ) {
860 fprintf( stderr, _("Bad filter pattern \"%s\"\n"),
867 if( filtpattern[i+1] != 's' ) {
868 fprintf( stderr, _("Bad filter pattern \"%s\"\n"),
876 if ( tmpdir == NULL ) {
879 if ( urlpre == NULL )
883 if( urlpre == NULL ) {
884 urlpre = malloc( sizeof("file:////") + strlen(tmpdir) );
886 if( urlpre == NULL ) {
891 sprintf( urlpre, "file:///%s/",
892 tmpdir[0] == *LDAP_DIRSEP ? &tmpdir[1] : tmpdir );
900 ld = tool_conn_setup( 0, &private_conn_setup );
905 save_nctrls = nctrls;
908 #ifdef LDAP_CONTROL_DONTUSECOPY
911 #ifdef LDAP_CONTROL_X_DEREF
919 || valuesReturnFilter
923 #ifdef LDAP_CONTROL_DONTUSECOPY
929 c[i].ldctl_oid = LDAP_CONTROL_DONTUSECOPY;
930 c[i].ldctl_value.bv_val = NULL;
931 c[i].ldctl_value.bv_len = 0;
932 c[i].ldctl_iscritical = dontUseCopy > 1;
942 c[i].ldctl_oid = LDAP_CONTROL_X_DOMAIN_SCOPE;
943 c[i].ldctl_value.bv_val = NULL;
944 c[i].ldctl_value.bv_len = 0;
945 c[i].ldctl_iscritical = domainScope > 1;
954 if (( seber = ber_alloc_t(LBER_USE_DER)) == NULL ) {
958 err = ber_printf( seber, "b", abs(subentries) == 1 ? 0 : 1 );
960 ber_free( seber, 1 );
961 fprintf( stderr, _("Subentries control encoding error!\n") );
965 if ( ber_flatten2( seber, &c[i].ldctl_value, 0 ) == -1 ) {
969 c[i].ldctl_oid = LDAP_CONTROL_SUBENTRIES;
970 c[i].ldctl_iscritical = subentries < 1;
979 if (( syncber = ber_alloc_t(LBER_USE_DER)) == NULL ) {
983 if ( sync_cookie.bv_len == 0 ) {
984 err = ber_printf( syncber, "{e}", abs(ldapsync) );
986 err = ber_printf( syncber, "{eO}", abs(ldapsync),
991 ber_free( syncber, 1 );
992 fprintf( stderr, _("ldap sync control encoding error!\n") );
996 if ( ber_flatten( syncber, &syncbvalp ) == -1 ) {
1000 c[i].ldctl_oid = LDAP_CONTROL_SYNC;
1001 c[i].ldctl_value = (*syncbvalp);
1002 c[i].ldctl_iscritical = ldapsync < 0;
1006 if ( valuesReturnFilter ) {
1008 return EXIT_FAILURE;
1011 if (( vrber = ber_alloc_t(LBER_USE_DER)) == NULL ) {
1012 return EXIT_FAILURE;
1015 if ( ( err = ldap_put_vrFilter( vrber, vrFilter ) ) == -1 ) {
1016 ber_free( vrber, 1 );
1017 fprintf( stderr, _("Bad ValuesReturnFilter: %s\n"), vrFilter );
1018 return EXIT_FAILURE;
1021 if ( ber_flatten2( vrber, &c[i].ldctl_value, 0 ) == -1 ) {
1022 return EXIT_FAILURE;
1025 c[i].ldctl_oid = LDAP_CONTROL_VALUESRETURNFILTER;
1026 c[i].ldctl_iscritical = valuesReturnFilter > 1;
1030 if ( pagedResults ) {
1032 return EXIT_FAILURE;
1035 if ( ldap_create_page_control_value( ld,
1036 pageSize, &pr_cookie, &c[i].ldctl_value ) )
1038 return EXIT_FAILURE;
1041 if ( pr_cookie.bv_val != NULL ) {
1042 ber_memfree( pr_cookie.bv_val );
1043 pr_cookie.bv_val = NULL;
1044 pr_cookie.bv_len = 0;
1047 c[i].ldctl_oid = LDAP_CONTROL_PAGEDRESULTS;
1048 c[i].ldctl_iscritical = pagedResults > 1;
1054 return EXIT_FAILURE;
1057 if ( ldap_create_sort_control_value( ld,
1058 sss_keys, &c[i].ldctl_value ) )
1060 return EXIT_FAILURE;
1063 c[i].ldctl_oid = LDAP_CONTROL_SORTREQUEST;
1064 c[i].ldctl_iscritical = sss > 1;
1070 return EXIT_FAILURE;
1073 if ( ldap_create_vlv_control_value( ld,
1074 &vlvInfo, &c[i].ldctl_value ) )
1076 return EXIT_FAILURE;
1079 c[i].ldctl_oid = LDAP_CONTROL_VLVREQUEST;
1080 c[i].ldctl_iscritical = sss > 1;
1083 #ifdef LDAP_CONTROL_X_DEREF
1085 if ( derefval.bv_val == NULL ) {
1088 assert( ds != NULL );
1090 if ( ldap_create_deref_control_value( ld, ds, &derefval ) != LDAP_SUCCESS ) {
1091 return EXIT_FAILURE;
1094 for ( i = 0; ds[ i ].derefAttr != NULL; i++ ) {
1095 ldap_memfree( ds[ i ].derefAttr );
1096 ldap_charray_free( ds[ i ].attributes );
1103 exit( EXIT_FAILURE );
1106 c[ i ].ldctl_iscritical = derefcrit > 1;
1107 c[ i ].ldctl_oid = LDAP_CONTROL_X_DEREF;
1108 c[ i ].ldctl_value = derefval;
1111 #endif /* LDAP_CONTROL_X_DEREF */
1114 tool_server_controls( ld, c, i );
1116 if ( seber ) ber_free( seber, 1 );
1117 if ( vrber ) ber_free( vrber, 1 );
1119 /* step back to the original number of controls, so that
1120 * those set while parsing args are preserved */
1121 nctrls = save_nctrls;
1124 fprintf( stderr, _("filter%s: %s\nrequesting: "),
1125 infile != NULL ? _(" pattern") : "",
1128 if ( attrs == NULL ) {
1129 fprintf( stderr, _("All userApplication attributes") );
1131 for ( i = 0; attrs[ i ] != NULL; ++i ) {
1132 fprintf( stderr, "%s ", attrs[ i ] );
1135 fprintf( stderr, "\n" );
1139 printf( _("# extended LDIF\n") );
1140 } else if ( ldif < 3 ) {
1141 printf( _("version: %d\n\n"), 1 );
1145 char *realbase = base;
1147 if ( realbase == NULL ) {
1148 ldap_get_option( ld, LDAP_OPT_DEFBASE, (void **)(char *)&realbase );
1152 printf(_("# LDAPv%d\n"), protocol);
1153 printf(_("# base <%s>%s with scope %s\n"),
1154 realbase ? realbase : "",
1155 ( realbase == NULL || realbase != base ) ? " (default)" : "",
1156 ((scope == LDAP_SCOPE_BASE) ? "baseObject"
1157 : ((scope == LDAP_SCOPE_ONELEVEL) ? "oneLevel"
1158 : ((scope == LDAP_SCOPE_SUBORDINATE) ? "children"
1160 printf(_("# filter%s: %s\n"), infile != NULL ? _(" pattern") : "",
1162 printf(_("# requesting: "));
1164 if ( attrs == NULL ) {
1167 for ( i = 0; attrs[ i ] != NULL; ++i ) {
1168 printf( "%s ", attrs[ i ] );
1172 if ( manageDSAit ) {
1173 printf(_("\n# with manageDSAit %scontrol"),
1174 manageDSAit > 1 ? _("critical ") : "" );
1177 printf(_("\n# with noop %scontrol"),
1178 noop > 1 ? _("critical ") : "" );
1181 printf(_("\n# with subentries %scontrol: %s"),
1182 subentries < 0 ? _("critical ") : "",
1183 abs(subentries) == 1 ? "false" : "true" );
1185 if ( valuesReturnFilter ) {
1186 printf(_("\n# with valuesReturnFilter %scontrol: %s"),
1187 valuesReturnFilter > 1 ? _("critical ") : "", vrFilter );
1189 if ( pagedResults ) {
1190 printf(_("\n# with pagedResults %scontrol: size=%d"),
1191 (pagedResults > 1) ? _("critical ") : "",
1195 printf(_("\n# with server side sorting %scontrol"),
1196 sss > 1 ? _("critical ") : "" );
1199 printf(_("\n# with virtual list view %scontrol: %d/%d"),
1200 vlv > 1 ? _("critical ") : "",
1201 vlvInfo.ldvlv_before_count, vlvInfo.ldvlv_after_count);
1202 if ( vlvInfo.ldvlv_attrvalue )
1203 printf(":%s", vlvInfo.ldvlv_attrvalue->bv_val );
1205 printf("/%d/%d", vlvInfo.ldvlv_offset, vlvInfo.ldvlv_count );
1207 #ifdef LDAP_CONTROL_X_DEREF
1209 printf(_("\n# with dereference %scontrol"),
1210 derefcrit > 1 ? _("critical ") : "" );
1214 printf( _("\n#\n\n") );
1216 if ( realbase && realbase != base ) {
1217 ldap_memfree( realbase );
1221 if ( infile == NULL ) {
1222 rc = dosearch( ld, base, scope, NULL, filtpattern,
1223 attrs, attrsonly, NULL, NULL, NULL, -1 );
1228 while ( fgets( line, sizeof( line ), fp ) != NULL ) {
1229 line[ strlen( line ) - 1 ] = '\0';
1235 rc1 = dosearch( ld, base, scope, filtpattern, line,
1236 attrs, attrsonly, NULL, NULL, NULL, -1 );
1244 if ( fp != stdin ) {
1249 if (( rc == LDAP_SUCCESS ) && pageSize && pr_morePagedResults ) {
1251 int i, moreEntries, tmpSize;
1253 /* Loop to get the next pages when
1254 * enter is pressed on the terminal.
1256 if ( pagePrompt != 0 ) {
1257 if ( entriesLeft > 0 ) {
1258 printf( _("Estimate entries: %d\n"), entriesLeft );
1260 printf( _("Press [size] Enter for the next {%d|size} entries.\n"),
1263 moreEntries = getchar();
1264 while ( moreEntries != EOF && moreEntries != '\n' ) {
1265 if ( i < (int)sizeof(buf) - 1 ) {
1266 buf[i] = moreEntries;
1269 moreEntries = getchar();
1273 if ( i > 0 && isdigit( (unsigned char)buf[0] ) ) {
1274 int num = sscanf( buf, "%d", &tmpSize );
1277 _("Invalid value for PagedResultsControl, %s.\n"), buf);
1278 return EXIT_FAILURE;
1281 pageSize = (ber_int_t)tmpSize;
1288 if (( rc == LDAP_SUCCESS ) && vlv ) {
1292 /* Loop to get the next window when
1293 * enter is pressed on the terminal.
1295 printf( _("Press [before/after(/offset/count|:value)] Enter for the next window.\n"));
1297 moreEntries = getchar();
1298 while ( moreEntries != EOF && moreEntries != '\n' ) {
1299 if ( i < (int)sizeof(buf) - 1 ) {
1300 buf[i] = moreEntries;
1303 moreEntries = getchar();
1307 i = parse_vlv( strdup( buf ));
1309 return EXIT_FAILURE;
1311 vlvInfo.ldvlv_attrvalue = NULL;
1312 vlvInfo.ldvlv_count = vlvCount;
1313 vlvInfo.ldvlv_offset += vlvInfo.ldvlv_after_count;
1316 if ( vlvInfo.ldvlv_context )
1317 ber_bvfree( vlvInfo.ldvlv_context );
1318 vlvInfo.ldvlv_context = vlvContext;
1325 if ( base != NULL ) {
1326 ber_memfree( base );
1328 if ( control != NULL ) {
1329 ber_memfree( control );
1331 if ( sss_keys != NULL ) {
1332 ldap_free_sort_keylist( sss_keys );
1334 if ( derefval.bv_val != NULL ) {
1335 ldap_memfree( derefval.bv_val );
1337 if ( def_urlpre != NULL ) {
1338 ber_memfree( def_urlpre );
1342 for ( ; save_nctrls-- > 0; ) {
1343 ber_memfree( c[ save_nctrls ].ldctl_value.bv_val );
1353 static int dosearch(
1361 LDAPControl **sctrls,
1362 LDAPControl **cctrls,
1363 struct timeval *timeout,
1373 LDAPMessage *res, *msg;
1375 char *retoid = NULL;
1376 struct berval *retdata = NULL;
1377 int nresponses_psearch = -1;
1378 int cancel_msgid = -1;
1380 if( filtpatt != NULL ) {
1381 size_t max_fsize = strlen( filtpatt ) + strlen( value ) + 1, outlen;
1382 filter = malloc( max_fsize );
1383 if( filter == NULL ) {
1385 return EXIT_FAILURE;
1388 outlen = snprintf( filter, max_fsize, filtpatt, value );
1389 if( outlen >= max_fsize ) {
1390 fprintf( stderr, "Bad filter pattern: \"%s\"\n", filtpatt );
1392 return EXIT_FAILURE;
1396 fprintf( stderr, _("filter: %s\n"), filter );
1400 printf( _("#\n# filter: %s\n#\n"), filter );
1408 if ( filtpatt != NULL ) {
1411 return LDAP_SUCCESS;
1414 rc = ldap_search_ext( ld, base, scope, filter, attrs, attrsonly,
1415 sctrls, cctrls, timeout, sizelimit, &msgid );
1417 if ( filtpatt != NULL ) {
1421 if( rc != LDAP_SUCCESS ) {
1422 fprintf( stderr, _("%s: ldap_search_ext: %s (%d)\n"),
1423 prog, ldap_err2string( rc ), rc );
1427 nresponses = nentries = nreferences = nextended = npartial = 0;
1431 while ((rc = ldap_result( ld, LDAP_RES_ANY,
1432 sortattr ? LDAP_MSG_ALL : LDAP_MSG_ONE,
1435 rc = tool_check_abandon( ld, msgid );
1441 (void) ldap_sort_entries( ld, &res,
1442 ( *sortattr == '\0' ) ? NULL : sortattr, strcasecmp );
1445 for ( msg = ldap_first_message( ld, res );
1447 msg = ldap_next_message( ld, msg ) )
1449 if ( nresponses++ ) putchar('\n');
1450 if ( nresponses_psearch >= 0 )
1451 nresponses_psearch++;
1453 switch( ldap_msgtype( msg ) ) {
1454 case LDAP_RES_SEARCH_ENTRY:
1456 print_entry( ld, msg, attrsonly );
1459 case LDAP_RES_SEARCH_REFERENCE:
1461 print_reference( ld, msg );
1464 case LDAP_RES_EXTENDED:
1466 print_extended( ld, msg );
1468 if ( ldap_msgid( msg ) == 0 ) {
1469 /* unsolicited extended operation */
1473 if ( cancel_msgid != -1 &&
1474 cancel_msgid == ldap_msgid( msg ) ) {
1475 printf(_("Cancelled \n"));
1476 printf(_("cancel_msgid = %d\n"), cancel_msgid);
1481 case LDAP_RES_SEARCH_RESULT:
1482 /* pagedResults stuff is dealt with
1483 * in tool_print_ctrls(), called by
1484 * print_results(). */
1485 rc = print_result( ld, msg, 1 );
1486 if ( ldapsync == LDAP_SYNC_REFRESH_AND_PERSIST ) {
1492 case LDAP_RES_INTERMEDIATE:
1494 ldap_parse_intermediate( ld, msg,
1495 &retoid, &retdata, NULL, 0 );
1497 nresponses_psearch = 0;
1499 if ( strcmp( retoid, LDAP_SYNC_INFO ) == 0 ) {
1500 printf(_("SyncInfo Received\n"));
1501 ldap_memfree( retoid );
1502 ber_bvfree( retdata );
1506 print_partial( ld, msg );
1507 ldap_memfree( retoid );
1508 ber_bvfree( retdata );
1512 if ( ldapsync && sync_slimit != -1 &&
1513 nresponses_psearch >= sync_slimit ) {
1514 BerElement *msgidber = NULL;
1515 struct berval *msgidvalp = NULL;
1516 msgidber = ber_alloc_t(LBER_USE_DER);
1517 ber_printf(msgidber, "{i}", msgid);
1518 ber_flatten(msgidber, &msgidvalp);
1519 ldap_extended_operation(ld, LDAP_EXOP_CANCEL,
1520 msgidvalp, NULL, NULL, &cancel_msgid);
1521 nresponses_psearch = -1;
1525 ldap_msgfree( res );
1530 tool_perror( "ldap_result", rc, NULL, NULL, NULL, NULL );
1534 ldap_msgfree( res );
1536 if ( pagedResults ) {
1537 npagedresponses += nresponses;
1538 npagedentries += nentries;
1539 npagedextended += nextended;
1540 npagedpartial += npartial;
1541 npagedreferences += nreferences;
1542 if ( ( pr_morePagedResults == 0 ) && ( ldif < 2 ) ) {
1543 printf( _("\n# numResponses: %d\n"), npagedresponses );
1544 if( npagedentries ) {
1545 printf( _("# numEntries: %d\n"), npagedentries );
1547 if( npagedextended ) {
1548 printf( _("# numExtended: %d\n"), npagedextended );
1550 if( npagedpartial ) {
1551 printf( _("# numPartial: %d\n"), npagedpartial );
1553 if( npagedreferences ) {
1554 printf( _("# numReferences: %d\n"), npagedreferences );
1557 } else if ( ldif < 2 ) {
1558 printf( _("\n# numResponses: %d\n"), nresponses );
1559 if( nentries ) printf( _("# numEntries: %d\n"), nentries );
1560 if( nextended ) printf( _("# numExtended: %d\n"), nextended );
1561 if( npartial ) printf( _("# numPartial: %d\n"), npartial );
1562 if( nreferences ) printf( _("# numReferences: %d\n"), nreferences );
1568 /* This is the proposed new way of doing things.
1569 * It is more efficient, but the API is non-standard.
1578 char tmpfname[ 256 ];
1581 BerElement *ber = NULL;
1582 struct berval bv, *bvals, **bvp = &bvals;
1583 LDAPControl **ctrls = NULL;
1586 rc = ldap_get_dn_ber( ld, entry, &ber, &bv );
1589 ufn = ldap_dn2ufn( bv.bv_val );
1590 tool_write_ldif( LDIF_PUT_COMMENT, NULL, ufn, ufn ? strlen( ufn ) : 0 );
1592 tool_write_ldif( LDIF_PUT_VALUE, "dn", bv.bv_val, bv.bv_len );
1594 rc = ldap_get_entry_controls( ld, entry, &ctrls );
1595 if( rc != LDAP_SUCCESS ) {
1596 fprintf(stderr, _("print_entry: %d\n"), rc );
1597 tool_perror( "ldap_get_entry_controls", rc, NULL, NULL, NULL, NULL );
1598 exit( EXIT_FAILURE );
1602 tool_print_ctrls( ld, ctrls );
1603 ldap_controls_free( ctrls );
1608 ufn = ldap_dn2ufn( bv.bv_val );
1610 tool_write_ldif( LDIF_PUT_VALUE, "ufn", ufn, ufn ? strlen( ufn ) : 0 );
1613 if( ufn != NULL ) ldap_memfree( ufn );
1615 if ( attrsonly ) bvp = NULL;
1617 for ( rc = ldap_get_attribute_ber( ld, entry, ber, &bv, bvp );
1619 rc = ldap_get_attribute_ber( ld, entry, ber, &bv, bvp ) )
1621 if (bv.bv_val == NULL) break;
1624 tool_write_ldif( LDIF_PUT_NOVALUE, bv.bv_val, NULL, 0 );
1626 } else if ( bvals ) {
1627 for ( i = 0; bvals[i].bv_val != NULL; i++ ) {
1628 if ( vals2tmp > 1 || ( vals2tmp &&
1629 ldif_is_not_printable( bvals[i].bv_val, bvals[i].bv_len )))
1632 /* write value to file */
1633 snprintf( tmpfname, sizeof tmpfname,
1634 "%s" LDAP_DIRSEP "ldapsearch-%s-XXXXXX",
1635 tmpdir, bv.bv_val );
1638 tmpfd = mkstemp( tmpfname );
1645 if (( tmpfp = fdopen( tmpfd, "w")) == NULL ) {
1650 if ( fwrite( bvals[ i ].bv_val,
1651 bvals[ i ].bv_len, 1, tmpfp ) == 0 )
1660 snprintf( url, sizeof url, "%s%s", urlpre,
1661 &tmpfname[strlen(tmpdir) + sizeof(LDAP_DIRSEP) - 1] );
1664 tool_write_ldif( LDIF_PUT_URL, bv.bv_val, url, strlen( url ));
1667 tool_write_ldif( LDIF_PUT_VALUE, bv.bv_val,
1668 bvals[ i ].bv_val, bvals[ i ].bv_len );
1671 ber_memfree( bvals );
1680 static void print_reference(
1682 LDAPMessage *reference )
1686 LDAPControl **ctrls;
1689 printf(_("# search reference\n"));
1692 rc = ldap_parse_reference( ld, reference, &refs, &ctrls, 0 );
1694 if( rc != LDAP_SUCCESS ) {
1695 tool_perror( "ldap_parse_reference", rc, NULL, NULL, NULL, NULL );
1696 exit( EXIT_FAILURE );
1701 for( i=0; refs[i] != NULL; i++ ) {
1702 tool_write_ldif( ldif ? LDIF_PUT_COMMENT : LDIF_PUT_VALUE,
1703 "ref", refs[i], strlen(refs[i]) );
1705 ber_memvfree( (void **) refs );
1709 tool_print_ctrls( ld, ctrls );
1710 ldap_controls_free( ctrls );
1714 static void print_extended(
1716 LDAPMessage *extended )
1719 char *retoid = NULL;
1720 struct berval *retdata = NULL;
1723 printf(_("# extended result response\n"));
1726 rc = ldap_parse_extended_result( ld, extended,
1727 &retoid, &retdata, 0 );
1729 if( rc != LDAP_SUCCESS ) {
1730 tool_perror( "ldap_parse_extended_result", rc, NULL, NULL, NULL, NULL );
1731 exit( EXIT_FAILURE );
1735 tool_write_ldif( ldif ? LDIF_PUT_COMMENT : LDIF_PUT_VALUE,
1736 "extended", retoid, retoid ? strlen(retoid) : 0 );
1738 ber_memfree( retoid );
1742 tool_write_ldif( ldif ? LDIF_PUT_COMMENT : LDIF_PUT_BINARY,
1743 "data", retdata->bv_val, retdata->bv_len );
1745 ber_bvfree( retdata );
1748 print_result( ld, extended, 0 );
1751 static void print_partial(
1753 LDAPMessage *partial )
1756 char *retoid = NULL;
1757 struct berval *retdata = NULL;
1758 LDAPControl **ctrls = NULL;
1761 printf(_("# extended partial response\n"));
1764 rc = ldap_parse_intermediate( ld, partial,
1765 &retoid, &retdata, &ctrls, 0 );
1767 if( rc != LDAP_SUCCESS ) {
1768 tool_perror( "ldap_parse_intermediate", rc, NULL, NULL, NULL, NULL );
1769 exit( EXIT_FAILURE );
1773 tool_write_ldif( ldif ? LDIF_PUT_COMMENT : LDIF_PUT_VALUE,
1774 "partial", retoid, retoid ? strlen(retoid) : 0 );
1777 ber_memfree( retoid );
1781 tool_write_ldif( ldif ? LDIF_PUT_COMMENT : LDIF_PUT_BINARY,
1782 "data", retdata->bv_val, retdata->bv_len );
1785 ber_bvfree( retdata );
1789 tool_print_ctrls( ld, ctrls );
1790 ldap_controls_free( ctrls );
1794 static int print_result(
1796 LDAPMessage *result, int search )
1800 char *matcheddn = NULL;
1803 LDAPControl **ctrls = NULL;
1807 printf(_("# search result\n"));
1810 printf("%s: %d\n", _("search"), ldap_msgid(result) );
1814 rc = ldap_parse_result( ld, result,
1815 &err, &matcheddn, &text, &refs, &ctrls, 0 );
1817 if( rc != LDAP_SUCCESS ) {
1818 tool_perror( "ldap_parse_result", rc, NULL, NULL, NULL, NULL );
1819 exit( EXIT_FAILURE );
1824 printf( _("result: %d %s\n"), err, ldap_err2string(err) );
1826 } else if ( err != LDAP_SUCCESS ) {
1827 fprintf( stderr, "%s (%d)\n", ldap_err2string(err), err );
1833 tool_write_ldif( LDIF_PUT_VALUE,
1834 "matchedDN", matcheddn, strlen(matcheddn) );
1836 fprintf( stderr, _("Matched DN: %s\n"), matcheddn );
1840 ber_memfree( matcheddn );
1846 if ( err == LDAP_PARTIAL_RESULTS ) {
1849 for ( line = text; line != NULL; ) {
1850 char *next = strchr( line, '\n' );
1852 tool_write_ldif( LDIF_PUT_TEXT,
1854 next ? (size_t) (next - line) : strlen( line ));
1856 line = next ? next + 1 : NULL;
1860 tool_write_ldif( LDIF_PUT_TEXT, "text",
1861 text, strlen(text) );
1864 fprintf( stderr, _("Additional information: %s\n"), text );
1868 ber_memfree( text );
1873 for( i=0; refs[i] != NULL; i++ ) {
1875 tool_write_ldif( LDIF_PUT_VALUE, "ref", refs[i], strlen(refs[i]) );
1877 fprintf( stderr, _("Referral: %s\n"), refs[i] );
1881 ber_memvfree( (void **) refs );
1884 pr_morePagedResults = 0;
1887 tool_print_ctrls( ld, ctrls );
1888 ldap_controls_free( ctrls );