1 /* ldapcompare.c -- LDAP compare tool */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2009 The OpenLDAP Foundation.
6 * Portions Copyright 1998-2003 Kurt D. Zeilenga.
7 * Portions Copyright 1998-2001 Net Boolean Incorporated.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted only as authorized by the OpenLDAP
14 * A copy of this license is available in the file LICENSE in the
15 * top-level directory of the distribution or, alternatively, at
16 * <http://www.OpenLDAP.org/license.html>.
18 /* Portions Copyright (c) 1992-1996 Regents of the University of Michigan.
19 * All rights reserved.
21 * Redistribution and use in source and binary forms are permitted
22 * provided that this notice is preserved and that due credit is given
23 * to the University of Michigan at Ann Arbor. The name of the
24 * University may not be used to endorse or promote products derived
25 * from this software without specific prior written permission. This
26 * software is provided ``as is'' without express or implied warranty.
28 /* Portions Copyright 2002, F5 Networks, Inc, All rights reserved.
29 * This software is not subject to any license of F5 Networks.
30 * This is free software; you can redistribute and use it
31 * under the same terms as OpenLDAP itself.
34 * This work was originally developed by Jeff Costlow (F5 Networks)
35 * based, in part, on existing LDAP tools and adapted for inclusion
36 * into OpenLDAP Software by Kurt D. Zeilenga.
43 #include <ac/stdlib.h>
46 #include <ac/string.h>
47 #include <ac/unistd.h>
49 #include <ac/socket.h>
56 #ifdef HAVE_SYS_TYPES_H
57 #include <sys/types.h>
66 #include "lutil_ldap.h"
67 #include "ldap_defaults.h"
78 fprintf( stderr, _("usage: %s [options] DN <attr:value|attr::b64value>\n"), prog);
79 fprintf( stderr, _("where:\n"));
80 fprintf( stderr, _(" DN\tDistinguished Name\n"));
81 fprintf( stderr, _(" attr\tassertion attribute\n"));
82 fprintf( stderr, _(" value\tassertion value\n"));
83 fprintf( stderr, _(" b64value\tbase64 encoding of assertion value\n"));
85 fprintf( stderr, _("Compare options:\n"));
86 fprintf( stderr, _(" -E [!]<ext>[=<extparam>] compare extensions (! indicates criticality)\n"));
87 fprintf( stderr, _(" !dontUseCopy (Don't Use Copy)\n"));
88 fprintf( stderr, _(" -M enable Manage DSA IT control (-MM to make critical)\n"));
89 fprintf( stderr, _(" -P version protocol version (default: 3)\n"));
90 fprintf( stderr, _(" -z Quiet mode,"
91 " don't print anything, use return values\n"));
96 static int docompare LDAP_P((
100 struct berval *bvalue,
102 LDAPControl **sctrls,
103 LDAPControl **cctrls));
106 const char options[] = "z"
107 "Cd:D:e:h:H:IMnNO:o:p:P:QR:U:vVw:WxX:y:Y:Z";
109 #ifdef LDAP_CONTROL_DONTUSECOPY
114 handle_private_option( int i )
116 char *control, *cvalue;
120 case 'E': /* compare extensions */
121 if( protocol == LDAP_VERSION2 ) {
122 fprintf( stderr, _("%s: -E incompatible with LDAPv%d\n"),
124 exit( EXIT_FAILURE );
127 /* should be extended to support comma separated list of
128 * [!]key[=value] parameters, e.g. -E !foo,bar=567
133 if( optarg[0] == '!' ) {
138 control = ber_strdup( optarg );
139 if ( (cvalue = strchr( control, '=' )) != NULL ) {
143 #ifdef LDAP_CONTROL_DONTUSECOPY
144 if ( strcasecmp( control, "dontUseCopy" ) == 0 ) {
147 _("dontUseCopy control previously specified\n"));
148 exit( EXIT_FAILURE );
150 if( cvalue != NULL ) {
152 _("dontUseCopy: no control value expected\n") );
157 _("dontUseCopy: critical flag required\n") );
161 dontUseCopy = 1 + crit;
166 _("Invalid compare extension name: %s\n"), control );
183 main( int argc, char **argv )
185 char *compdn = NULL, *attrs = NULL;
189 struct berval bvalue = { 0, NULL };
194 tool_init( TOOL_COMPARE );
195 prog = lutil_progname( "ldapcompare", argc, argv );
197 tool_args( argc, argv );
199 if ( argc - optind != 2 ) {
203 compdn = argv[optind++];
204 attrs = argv[optind++];
206 /* user passed in only 2 args, the last one better be in
207 * the form attr:value or attr::b64value
209 sep = strchr(attrs, ':');
216 bvalue.bv_val = strdup( sep );
217 bvalue.bv_len = strlen( bvalue.bv_val );
220 /* it's base64 encoded. */
221 bvalue.bv_val = malloc( strlen( &sep[1] ));
222 bvalue.bv_len = lutil_b64_pton( &sep[1],
223 (unsigned char *) bvalue.bv_val, strlen( &sep[1] ));
225 if (bvalue.bv_len == (ber_len_t)-1) {
226 fprintf(stderr, _("base64 decode error\n"));
231 ld = tool_conn_setup( 0, 0 );
233 if ( pw_file || want_bindpw ) {
235 rc = lutil_get_filed_password( pw_file, &passwd );
236 if( rc ) return EXIT_FAILURE;
238 passwd.bv_val = getpassphrase( _("Enter LDAP Password: ") );
239 passwd.bv_len = passwd.bv_val ? strlen( passwd.bv_val ) : 0;
246 #ifdef LDAP_CONTROL_DONTUSECOPY
251 #ifdef LDAP_CONTROL_DONTUSECOPY
253 c[i].ldctl_oid = LDAP_CONTROL_DONTUSECOPY;
254 c[i].ldctl_value.bv_val = NULL;
255 c[i].ldctl_value.bv_len = 0;
256 c[i].ldctl_iscritical = dontUseCopy > 1;
262 tool_server_controls( ld, c, i );
265 fprintf( stderr, _("DN:%s, attr:%s, value:%s\n"),
266 compdn, attrs, sep );
269 rc = docompare( ld, compdn, attrs, &bvalue, quiet, NULL, NULL );
271 free( bvalue.bv_val );
279 static int docompare(
283 struct berval *bvalue,
285 LDAPControl **sctrls,
286 LDAPControl **cctrls )
293 LDAPControl **ctrls = NULL;
299 rc = ldap_compare_ext( ld, dn, attr, bvalue,
300 sctrls, cctrls, &msgid );
311 if ( tool_check_abandon( ld, msgid ) ) {
312 return LDAP_CANCELLED;
315 rc = ldap_result( ld, LDAP_RES_ANY, LDAP_MSG_ALL, &tv, &res );
317 tool_perror( "ldap_result", rc, NULL, NULL, NULL, NULL );
326 rc = ldap_parse_result( ld, res, &code, &matcheddn, &text, &refs, &ctrls, 1 );
328 if( rc != LDAP_SUCCESS ) {
329 fprintf( stderr, "%s: ldap_parse_result: %s (%d)\n",
330 prog, ldap_err2string( rc ), rc );
334 if ( !quiet && ( verbose || ( code != LDAP_SUCCESS && code != LDAP_COMPARE_TRUE && code != LDAP_COMPARE_FALSE )||
335 (matcheddn && *matcheddn) || (text && *text) || (refs && *refs) ) )
337 printf( _("Compare Result: %s (%d)\n"),
338 ldap_err2string( code ), code );
340 if( text && *text ) {
341 printf( _("Additional info: %s\n"), text );
344 if( matcheddn && *matcheddn ) {
345 printf( _("Matched DN: %s\n"), matcheddn );
350 for( i=0; refs[i]; i++ ) {
351 printf(_("Referral: %s\n"), refs[i] );
356 /* if we were told to be quiet, use the return value. */
358 if ( code == LDAP_COMPARE_TRUE ) {
360 } else if ( code == LDAP_COMPARE_FALSE ) {
361 printf(_("FALSE\n"));
363 printf(_("UNDEFINED\n"));
368 tool_print_ctrls( ld, ctrls );
369 ldap_controls_free( ctrls );
373 ber_memfree( matcheddn );
374 ber_memvfree( (void **) refs );