]> git.sur5r.net Git - openldap/blobdiff - clients/tools/ldapcompare.c
Merge remote branch 'origin/mdb.master' into OPENLDAP_REL_ENG_2_4
[openldap] / clients / tools / ldapcompare.c
index 18ea6efee7efa535efd181589a801297dab23932..831f11674c78bfb66b6eaf1d62d14767fba5eaf8 100644 (file)
@@ -1,8 +1,40 @@
-/*
- * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
- * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
- */
+/* ldapcompare.c -- LDAP compare tool */
 /* $OpenLDAP$ */
+/* This work is part of OpenLDAP Software <http://www.openldap.org/>.
+ *
+ * Copyright 1998-2012 The OpenLDAP Foundation.
+ * Portions Copyright 1998-2003 Kurt D. Zeilenga.
+ * Portions Copyright 1998-2001 Net Boolean Incorporated.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted only as authorized by the OpenLDAP
+ * Public License.
+ *
+ * A copy of this license is available in the file LICENSE in the
+ * top-level directory of the distribution or, alternatively, at
+ * <http://www.OpenLDAP.org/license.html>.
+ */
+/* Portions Copyright (c) 1992-1996 Regents of the University of Michigan.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms are permitted
+ * provided that this notice is preserved and that due credit is given
+ * to the University of Michigan at Ann Arbor.  The name of the
+ * University may not be used to endorse or promote products derived
+ * from this software without specific prior written permission.  This
+ * software is provided ``as is'' without express or implied warranty.
+ */
+/* Portions Copyright 2002, F5 Networks, Inc, All rights reserved.
+ * This software is not subject to any license of F5 Networks.
+ * This is free software; you can redistribute and use it
+ * under the same terms as OpenLDAP itself.
+ */
+/* ACKNOWLEDGEMENTS:
+ * This work was originally developed by Jeff Costlow (F5 Networks)
+ * based, in part, on existing LDAP tools and adapted for inclusion
+ * into OpenLDAP Software by Kurt D. Zeilenga.
+ */
 
 #include "portable.h"
 
@@ -14,6 +46,8 @@
 #include <ac/string.h>
 #include <ac/unistd.h>
 #include <ac/errno.h>
+#include <ac/socket.h>
+#include <ac/time.h>
 #include <sys/stat.h>
 
 #ifdef HAVE_FCNTL_H
@@ -28,7 +62,6 @@
 
 #include <ldap.h>
 
-#include "ldif.h"
 #include "lutil.h"
 #include "lutil_ldap.h"
 #include "ldap_defaults.h"
@@ -42,17 +75,20 @@ static int quiet = 0;
 void
 usage( void )
 {
-       fprintf( stderr,
-"usage: %s [options] DN <attr:value|attr::b64value>\n"
-"where:\n"
-"  DN\tDistinguished Name\n"
-"  attr\tassertion attribute\n"
-"  value\tassertion value\n"
-"  b64value\tbase64 encoding of assertion value\n"
-
-"Compare options:\n"
-"  -z         Quiet mode, don't print anything, use return values\n"
-                , prog );
+       fprintf( stderr, _("usage: %s [options] DN <attr:value|attr::b64value>\n"), prog);
+       fprintf( stderr, _("where:\n"));
+       fprintf( stderr, _("  DN\tDistinguished Name\n"));
+       fprintf( stderr, _("  attr\tassertion attribute\n"));
+       fprintf( stderr, _("  value\tassertion value\n"));
+       fprintf( stderr, _("  b64value\tbase64 encoding of assertion value\n"));
+
+       fprintf( stderr, _("Compare options:\n"));
+       fprintf( stderr, _("  -E [!]<ext>[=<extparam>] compare extensions (! indicates criticality)\n"));
+       fprintf( stderr, _("             !dontUseCopy                (Don't Use Copy)\n"));
+       fprintf( stderr, _("  -M         enable Manage DSA IT control (-MM to make critical)\n"));
+       fprintf( stderr, _("  -P version protocol version (default: 3)\n"));
+       fprintf( stderr, _("  -z         Quiet mode,"
+               " don't print anything, use return values\n"));
        tool_common_usage();
        exit( EXIT_FAILURE );
 }
@@ -68,18 +104,22 @@ static int docompare LDAP_P((
 
 
 const char options[] = "z"
-       "Cd:D:e:h:H:IkKMnO:p:P:QR:U:vVw:WxX:y:Y:Z";
+       "Cd:D:e:h:H:IMnNO:o:p:P:QR:U:vVw:WxX:y:Y:Z";
+
+#ifdef LDAP_CONTROL_DONTUSECOPY
+int dontUseCopy = 0;
+#endif
 
 int
 handle_private_option( int i )
 {
+       char    *control, *cvalue;
+       int             crit;
+
        switch ( i ) {
-#if 0
-               char    *control, *cvalue;
-               int             crit;
-       case 'E': /* compare controls */
+       case 'E': /* compare extensions */
                if( protocol == LDAP_VERSION2 ) {
-                       fprintf( stderr, "%s: -E incompatible with LDAPv%d\n",
+                       fprintf( stderr, _("%s: -E incompatible with LDAPv%d\n"),
                                prog, protocol );
                        exit( EXIT_FAILURE );
                }
@@ -95,13 +135,38 @@ handle_private_option( int i )
                        optarg++;
                }
 
-               control = strdup( optarg );
+               control = ber_strdup( optarg );
                if ( (cvalue = strchr( control, '=' )) != NULL ) {
                        *cvalue++ = '\0';
                }
-               fprintf( stderr, "Invalid compare control name: %s\n", control );
-               usage();
+
+#ifdef LDAP_CONTROL_DONTUSECOPY
+               if ( strcasecmp( control, "dontUseCopy" ) == 0 ) {
+                       if( dontUseCopy ) {
+                               fprintf( stderr,
+                                       _("dontUseCopy control previously specified\n"));
+                               exit( EXIT_FAILURE );
+                       }
+                       if( cvalue != NULL ) {
+                               fprintf( stderr,
+                                       _("dontUseCopy: no control value expected\n") );
+                               usage();
+                       }
+                       if( !crit ) {
+                               fprintf( stderr,
+                                       _("dontUseCopy: critical flag required\n") );
+                               usage();
+                       }
+
+                       dontUseCopy = 1 + crit;
+               } else
 #endif
+               {
+                       fprintf( stderr,
+                               _("Invalid compare extension name: %s\n"), control );
+                       usage();
+               }
+               break;
 
        case 'z':
                quiet = 1;
@@ -117,12 +182,16 @@ handle_private_option( int i )
 int
 main( int argc, char **argv )
 {
-       char    *compdn = NULL, *attrs = NULL;
-       char    *sep;
+       char            *compdn = NULL, *attrs = NULL;
+       char            *sep;
        int             rc;
-       LDAP    *ld = NULL;
-       struct berval bvalue = { 0, NULL };
+       LDAP            *ld = NULL;
+       struct berval   bvalue = { 0, NULL };
+       int             i = 0; 
+       LDAPControl     c[1];
 
+
+       tool_init( TOOL_COMPARE );
        prog = lutil_progname( "ldapcompare", argc, argv );
 
        tool_args( argc, argv );
@@ -151,36 +220,39 @@ main( int argc, char **argv )
                /* it's base64 encoded. */
                bvalue.bv_val = malloc( strlen( &sep[1] ));
                bvalue.bv_len = lutil_b64_pton( &sep[1],
-                       bvalue.bv_val, strlen( &sep[1] ));
+                       (unsigned char *) bvalue.bv_val, strlen( &sep[1] ));
 
                if (bvalue.bv_len == (ber_len_t)-1) {
-                       fprintf(stderr, "base64 decode error\n");
+                       fprintf(stderr, _("base64 decode error\n"));
                        exit(-1);
                }
        }
 
-       if ( debug )
-               ldif_debug = debug;
-
        ld = tool_conn_setup( 0, 0 );
 
-       if ( pw_file || want_bindpw ) {
-               if ( pw_file ) {
-                       rc = lutil_get_filed_password( pw_file, &passwd );
-                       if( rc ) return EXIT_FAILURE;
-               } else {
-                       passwd.bv_val = getpassphrase( "Enter LDAP Password: " );
-                       passwd.bv_len = passwd.bv_val ? strlen( passwd.bv_val ) : 0;
+       tool_bind( ld );
+
+       if ( 0
+#ifdef LDAP_CONTROL_DONTUSECOPY
+               || dontUseCopy
+#endif
+               )
+       {
+#ifdef LDAP_CONTROL_DONTUSECOPY
+               if ( dontUseCopy ) {  
+                       c[i].ldctl_oid = LDAP_CONTROL_DONTUSECOPY;
+                       c[i].ldctl_value.bv_val = NULL;
+                       c[i].ldctl_value.bv_len = 0;
+                       c[i].ldctl_iscritical = dontUseCopy > 1;
+                       i++;    
                }
+#endif
        }
 
-       tool_bind( ld );
-
-       if ( authzid || manageDSAit || noop )
-               tool_server_controls( ld, NULL, 0 );
+       tool_server_controls( ld, c, i );
 
        if ( verbose ) {
-               fprintf( stderr, "DN:%s, attr:%s, value:%s\n",
+               fprintf( stderr, _("DN:%s, attr:%s, value:%s\n"),
                        compdn, attrs, sep );
        }
 
@@ -188,9 +260,7 @@ main( int argc, char **argv )
 
        free( bvalue.bv_val );
 
-       ldap_unbind( ld );
-
-       return rc;
+       tool_exit( ld, rc );
 }
 
 
@@ -203,33 +273,94 @@ static int docompare(
        LDAPControl **sctrls,
        LDAPControl **cctrls )
 {
-       int                     rc;
-
-       if ( not ) {
+       int             rc, msgid, code;
+       LDAPMessage     *res;
+       char            *matcheddn;
+       char            *text;
+       char            **refs;
+       LDAPControl **ctrls = NULL;
+
+       if ( dont ) {
                return LDAP_SUCCESS;
        }
 
-       rc = ldap_compare_ext_s( ld, dn, attr, bvalue,
-               sctrls, cctrls );
-
+       rc = ldap_compare_ext( ld, dn, attr, bvalue,
+               sctrls, cctrls, &msgid );
        if ( rc == -1 ) {
-               ldap_perror( ld, "ldap_result" );
                return( rc );
        }
 
+       for ( ; ; ) {
+               struct timeval  tv;
+
+               tv.tv_sec = 0;
+               tv.tv_usec = 100000;
+
+               if ( tool_check_abandon( ld, msgid ) ) {
+                       return LDAP_CANCELLED;
+               }
+
+               rc = ldap_result( ld, LDAP_RES_ANY, LDAP_MSG_ALL, &tv, &res );
+               if ( rc < 0 ) {
+                       tool_perror( "ldap_result", rc, NULL, NULL, NULL, NULL );
+                       return rc;
+               }
+
+               if ( rc != 0 ) {
+                       break;
+               }
+       }
+
+       rc = ldap_parse_result( ld, res, &code, &matcheddn, &text, &refs, &ctrls, 1 );
+
+       if( rc != LDAP_SUCCESS ) {
+               fprintf( stderr, "%s: ldap_parse_result: %s (%d)\n",
+                       prog, ldap_err2string( rc ), rc );
+               return rc;
+       }
+
+       if ( !quiet && ( verbose || ( code != LDAP_SUCCESS && code != LDAP_COMPARE_TRUE && code != LDAP_COMPARE_FALSE )||
+               (matcheddn && *matcheddn) || (text && *text) || (refs && *refs) ) )
+       {
+               printf( _("Compare Result: %s (%d)\n"),
+                       ldap_err2string( code ), code );
+
+               if( text && *text ) {
+                       printf( _("Additional info: %s\n"), text );
+               }
+
+               if( matcheddn && *matcheddn ) {
+                       printf( _("Matched DN: %s\n"), matcheddn );
+               }
+
+               if( refs ) {
+                       int i;
+                       for( i=0; refs[i]; i++ ) {
+                               printf(_("Referral: %s\n"), refs[i] );
+                       }
+               }
+       }
+
        /* if we were told to be quiet, use the return value. */
        if ( !quiet ) {
-               if ( rc == LDAP_COMPARE_TRUE ) {
-                       rc = 0;
-                       printf("TRUE\n");
-               } else if ( rc == LDAP_COMPARE_FALSE ) {
-                       rc = 0;
-                       printf("FALSE\n");
+               if ( code == LDAP_COMPARE_TRUE ) {
+                       printf(_("TRUE\n"));
+               } else if ( code == LDAP_COMPARE_FALSE ) {
+                       printf(_("FALSE\n"));
                } else {
-                       ldap_perror( ld, "ldap_compare" );
+                       printf(_("UNDEFINED\n"));
                }
        }
 
-       return( rc );
+       if ( ctrls ) {
+               tool_print_ctrls( ld, ctrls );
+               ldap_controls_free( ctrls );
+       }
+
+       ber_memfree( text );
+       ber_memfree( matcheddn );
+       ber_memvfree( (void **) refs );
+
+       return( code );
 }