1 /* ldapcompare.c -- LDAP compare tool */
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.
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>
55 #ifdef HAVE_SYS_TYPES_H
56 #include <sys/types.h>
65 #include "lutil_ldap.h"
66 #include "ldap_defaults.h"
77 fprintf( stderr, _("usage: %s [options] DN <attr:value|attr::b64value>\n"), prog);
78 fprintf( stderr, _("where:\n"));
79 fprintf( stderr, _(" DN\tDistinguished Name\n"));
80 fprintf( stderr, _(" attr\tassertion attribute\n"));
81 fprintf( stderr, _(" value\tassertion value\n"));
82 fprintf( stderr, _(" b64value\tbase64 encoding of assertion value\n"));
84 fprintf( stderr, _("Compare options:\n"));
85 fprintf( stderr, _(" -E [!]<ext>[=<extparam>] compare extensions (! indicates criticality)\n"));
86 fprintf( stderr, _(" !dontUseCopy (Don't Use Copy)\n"));
87 fprintf( stderr, _(" -z Quiet mode,"
88 " don't print anything, use return values\n"));
93 static int docompare LDAP_P((
97 struct berval *bvalue,
100 LDAPControl **cctrls));
103 const char options[] = "z"
104 "Cd:D:e:h:H:IkKMnO:p:P:QR:U:vVw:WxX:y:Y:Z";
106 #ifdef LDAP_CONTROL_DONTUSECOPY
111 handle_private_option( int i )
113 char *control, *cvalue;
117 case 'E': /* compare extensions */
118 if( protocol == LDAP_VERSION2 ) {
119 fprintf( stderr, _("%s: -E incompatible with LDAPv%d\n"),
121 exit( EXIT_FAILURE );
124 /* should be extended to support comma separated list of
125 * [!]key[=value] parameters, e.g. -E !foo,bar=567
130 if( optarg[0] == '!' ) {
135 control = ber_strdup( optarg );
136 if ( (cvalue = strchr( control, '=' )) != NULL ) {
140 #ifdef LDAP_CONTROL_DONTUSECOPY
141 if ( strcasecmp( control, "dontUseCopy" ) == 0 ) {
144 _("dontUseCopy control previously specified\n"));
145 exit( EXIT_FAILURE );
147 if( cvalue != NULL ) {
149 _("dontUseCopy: no control value expected\n") );
154 _("dontUseCopy: critical flag required\n") );
158 dontUseCopy = 1 + crit;
163 _("Invalid compare extension name: %s\n"), control );
180 main( int argc, char **argv )
182 char *compdn = NULL, *attrs = NULL;
186 struct berval bvalue = { 0, NULL };
191 tool_init( TOOL_COMPARE );
192 prog = lutil_progname( "ldapcompare", argc, argv );
194 tool_args( argc, argv );
196 if ( argc - optind != 2 ) {
200 compdn = argv[optind++];
201 attrs = argv[optind++];
203 /* user passed in only 2 args, the last one better be in
204 * the form attr:value or attr::b64value
206 sep = strchr(attrs, ':');
213 bvalue.bv_val = strdup( sep );
214 bvalue.bv_len = strlen( bvalue.bv_val );
217 /* it's base64 encoded. */
218 bvalue.bv_val = malloc( strlen( &sep[1] ));
219 bvalue.bv_len = lutil_b64_pton( &sep[1],
220 (unsigned char *) bvalue.bv_val, strlen( &sep[1] ));
222 if (bvalue.bv_len == (ber_len_t)-1) {
223 fprintf(stderr, _("base64 decode error\n"));
228 ld = tool_conn_setup( 0, 0 );
230 if ( pw_file || want_bindpw ) {
232 rc = lutil_get_filed_password( pw_file, &passwd );
233 if( rc ) return EXIT_FAILURE;
235 passwd.bv_val = getpassphrase( _("Enter LDAP Password: ") );
236 passwd.bv_len = passwd.bv_val ? strlen( passwd.bv_val ) : 0;
243 #ifdef LDAP_CONTROL_DONTUSECOPY
248 #ifdef LDAP_CONTROL_DONTUSECOPY
250 c[i].ldctl_oid = LDAP_CONTROL_DONTUSECOPY;
251 c[i].ldctl_value.bv_val = NULL;
252 c[i].ldctl_value.bv_len = 0;
253 c[i].ldctl_iscritical = dontUseCopy > 1;
259 tool_server_controls( ld, c, i );
262 fprintf( stderr, _("DN:%s, attr:%s, value:%s\n"),
263 compdn, attrs, sep );
266 rc = docompare( ld, compdn, attrs, &bvalue, quiet, NULL, NULL );
268 free( bvalue.bv_val );
276 static int docompare(
280 struct berval *bvalue,
282 LDAPControl **sctrls,
283 LDAPControl **cctrls )
295 rc = ldap_compare_ext( ld, dn, attr, bvalue,
296 sctrls, cctrls, &msgid );
307 if ( tool_check_abandon( ld, msgid ) ) {
308 return LDAP_CANCELLED;
311 rc = ldap_result( ld, LDAP_RES_ANY, LDAP_MSG_ALL, &tv, &res );
313 tool_perror( "ldap_result", rc, NULL, NULL, NULL, NULL );
322 rc = ldap_parse_result( ld, res, &code, &matcheddn, &text, &refs, NULL, 1 );
324 if( rc != LDAP_SUCCESS ) {
325 fprintf( stderr, "%s: ldap_parse_result: %s (%d)\n",
326 prog, ldap_err2string( rc ), rc );
330 if ( !quiet && ( verbose || ( code != LDAP_SUCCESS && code != LDAP_COMPARE_TRUE && code != LDAP_COMPARE_FALSE )||
331 (matcheddn && *matcheddn) || (text && *text) || (refs && *refs) ) )
333 printf( _("Compare Result: %s (%d)\n"),
334 ldap_err2string( code ), code );
336 if( text && *text ) {
337 printf( _("Additional info: %s\n"), text );
340 if( matcheddn && *matcheddn ) {
341 printf( _("Matched DN: %s\n"), matcheddn );
346 for( i=0; refs[i]; i++ ) {
347 printf(_("Referral: %s\n"), refs[i] );
353 ber_memfree( matcheddn );
354 ber_memvfree( (void **) refs );
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"));