/*
|
* CDDL HEADER START
|
*
|
* The contents of this file are subject to the terms of the
|
* Common Development and Distribution License, Version 1.0 only
|
* (the "License"). You may not use this file except in compliance
|
* with the License.
|
*
|
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
|
* or http://forgerock.org/license/CDDLv1.0.html.
|
* See the License for the specific language governing permissions
|
* and limitations under the License.
|
*
|
* When distributing Covered Code, include this CDDL HEADER in each
|
* file and include the License file at legal-notices/CDDLv1_0.txt.
|
* If applicable, add the following below this CDDL HEADER, with the
|
* fields enclosed by brackets "[]" replaced with your own identifying
|
* information:
|
* Portions Copyright [yyyy] [name of copyright owner]
|
*
|
* CDDL HEADER END
|
*
|
*
|
* Copyright 2006-2010 Sun Microsystems, Inc.
|
* Portions Copyright 2012-2016 ForgeRock AS.
|
*/
|
package org.opends.server.tools;
|
|
import static com.forgerock.opendj.cli.ArgumentConstants.*;
|
import static com.forgerock.opendj.cli.CliMessages.INFO_DESCRIPTION_BINDPASSWORDFILE;
|
import static com.forgerock.opendj.cli.Utils.*;
|
|
import static org.opends.messages.ToolMessages.*;
|
import static org.opends.server.protocols.ldap.LDAPResultCode.*;
|
import static org.opends.server.util.args.LDAPConnectionArgumentParser.*;
|
|
import java.io.BufferedReader;
|
import java.io.FileReader;
|
import java.io.IOException;
|
import java.io.InputStreamReader;
|
import java.io.OutputStream;
|
import java.io.PrintStream;
|
import java.io.Reader;
|
import java.text.ParseException;
|
import java.util.ArrayList;
|
import java.util.List;
|
import java.util.concurrent.atomic.AtomicInteger;
|
|
import org.forgerock.i18n.LocalizableMessage;
|
import org.forgerock.opendj.ldap.ByteString;
|
import org.forgerock.opendj.ldap.DecodeException;
|
import org.opends.server.controls.LDAPAssertionRequestControl;
|
import org.opends.server.core.DirectoryServer.DirectoryServerVersionHandler;
|
import org.opends.server.protocols.ldap.CompareRequestProtocolOp;
|
import org.opends.server.protocols.ldap.CompareResponseProtocolOp;
|
import org.opends.server.protocols.ldap.LDAPFilter;
|
import org.opends.server.protocols.ldap.LDAPMessage;
|
import org.opends.server.protocols.ldap.ProtocolOp;
|
import org.opends.server.types.Control;
|
import org.opends.server.types.LDAPException;
|
import org.opends.server.types.NullOutputStream;
|
import org.opends.server.util.Base64;
|
import org.opends.server.util.EmbeddedUtils;
|
|
import com.forgerock.opendj.cli.ArgumentException;
|
import com.forgerock.opendj.cli.ArgumentParser;
|
import com.forgerock.opendj.cli.BooleanArgument;
|
import com.forgerock.opendj.cli.CliConstants;
|
import com.forgerock.opendj.cli.ClientException;
|
import com.forgerock.opendj.cli.CommonArguments;
|
import com.forgerock.opendj.cli.FileBasedArgument;
|
import com.forgerock.opendj.cli.IntegerArgument;
|
import com.forgerock.opendj.cli.StringArgument;
|
|
/**
|
* This class provides a tool that can be used to issue compare requests to the
|
* Directory Server.
|
*/
|
public class LDAPCompare
|
{
|
/** The fully-qualified name of this class. */
|
private static final String CLASS_NAME =
|
"org.opends.server.tools.LDAPCompare";
|
|
|
/** The message ID counter to use for requests. */
|
private final AtomicInteger nextMessageID;
|
|
/** The print stream to use for standard error. */
|
private final PrintStream err;
|
/** The print stream to use for standard output. */
|
private final PrintStream out;
|
|
/** Tells whether the command-line is being executed in script friendly mode or not. */
|
private boolean isScriptFriendly;
|
|
|
/**
|
* Constructor for the LDAPCompare object.
|
*
|
* @param nextMessageID The message ID counter to use for requests.
|
* @param out The print stream to use for standard output.
|
* @param err The print stream to use for standard error.
|
*/
|
public LDAPCompare(AtomicInteger nextMessageID, PrintStream out,
|
PrintStream err)
|
{
|
this.nextMessageID = nextMessageID;
|
this.out = out;
|
this.err = err;
|
}
|
|
/**
|
* Execute the compare request in the specified list of DNs.
|
*
|
* @param connection The connection to execute the request on.
|
* @param attributeType The attribute type to compare.
|
* @param attributeVal The attribute value to compare.
|
* @param lines The list of DNs to compare the attribute in.
|
* @param compareOptions The constraints for the compare request.
|
* @return the LDAP result code for the operation
|
*
|
* @throws IOException If a problem occurs while communicating with the
|
* Directory Server.
|
*
|
* @throws LDAPException If the server returns an error response.
|
*/
|
public int readAndExecute(LDAPConnection connection, String attributeType,
|
byte[] attributeVal, List<String> lines,
|
LDAPCompareOptions compareOptions)
|
throws IOException, LDAPException
|
{
|
int aggResultCode = SUCCESS;
|
for(String line : lines)
|
{
|
int resultCode =
|
executeCompare(connection, attributeType, attributeVal, line,
|
compareOptions);
|
aggResultCode = aggregateResultCode(aggResultCode, resultCode);
|
}
|
return aggResultCode;
|
}
|
|
|
/**
|
* Read the specified DNs from the given reader
|
* (file or stdin) and execute the given compare request.
|
*
|
* @param connection The connection to execute the request on.
|
* @param attributeType The attribute type to compare.
|
* @param attributeVal The attribute value to compare.
|
* @param reader The reader to read the list of DNs from.
|
* @param compareOptions The constraints for the compare request.
|
* @return the LDAP result code for the operation
|
*
|
* @throws IOException If a problem occurs while communicating with the
|
* Directory Server.
|
*
|
* @throws LDAPException If the server returns an error response.
|
*/
|
public int readAndExecute(LDAPConnection connection, String attributeType,
|
byte[] attributeVal, Reader reader,
|
LDAPCompareOptions compareOptions)
|
throws IOException, LDAPException
|
{
|
int aggResultCode = 0;
|
BufferedReader in = new BufferedReader(reader);
|
String line = null;
|
|
while ((line = in.readLine()) != null)
|
{
|
int resultCode =
|
executeCompare(connection, attributeType, attributeVal, line,
|
compareOptions);
|
aggResultCode = aggregateResultCode(aggResultCode, resultCode);
|
}
|
in.close();
|
return aggResultCode;
|
}
|
|
|
/**
|
* Aggregates a new result code to the existing aggregated result codes. This
|
* method always overwrites the {@link LDAPResultCode#SUCCESS} and
|
* {@link LDAPResultCode#COMPARE_TRUE} result codes with the new result code.
|
* Then
|
*
|
* @param aggResultCodes
|
* the aggregated result codes (a.k.a "accumulator")
|
* @param newResultCode
|
* the new result code to aggregate
|
* @return the new aggregated result code
|
*/
|
int aggregateResultCode(int aggResultCodes, int newResultCode)
|
{
|
if (aggResultCodes == SUCCESS || aggResultCodes == COMPARE_TRUE)
|
{
|
aggResultCodes = newResultCode;
|
}
|
else if (aggResultCodes == COMPARE_FALSE && newResultCode != COMPARE_TRUE)
|
{
|
aggResultCodes = newResultCode;
|
}
|
return aggResultCodes;
|
}
|
|
|
/**
|
* Execute the compare request for the specified DN entry.
|
*
|
* @param connection The connection to execute the request on.
|
* @param attributeType The attribute type to compare.
|
* @param attributeVal The attribute value to compare.
|
* @param line The DN to compare attribute in.
|
* @param compareOptions The constraints for the compare request.
|
* @return the LDAP result code for the operation
|
*
|
* @throws IOException If a problem occurs while communicating with the
|
* Directory Server.
|
*
|
* @throws LDAPException If the server returns an error response.
|
*/
|
private int executeCompare(LDAPConnection connection, String attributeType,
|
byte[] attributeVal, String line,
|
LDAPCompareOptions compareOptions)
|
throws IOException, LDAPException
|
{
|
ArrayList<Control> controls = compareOptions.getControls();
|
ByteString dnOctetStr = ByteString.valueOfUtf8(line);
|
ByteString attrValOctetStr = ByteString.wrap(attributeVal);
|
|
ProtocolOp protocolOp = new CompareRequestProtocolOp(dnOctetStr,
|
attributeType, attrValOctetStr);
|
|
|
if (!isScriptFriendly())
|
{
|
out.println(INFO_PROCESSING_COMPARE_OPERATION.get(
|
attributeType, attrValOctetStr, dnOctetStr));
|
}
|
|
if(!compareOptions.showOperations())
|
{
|
LDAPMessage responseMessage = null;
|
try
|
{
|
LDAPMessage message = new LDAPMessage(nextMessageID.getAndIncrement(),
|
protocolOp, controls);
|
connection.getLDAPWriter().writeMessage(message);
|
responseMessage = connection.getLDAPReader().readMessage();
|
} catch(DecodeException ae)
|
{
|
if (!compareOptions.continueOnError())
|
{
|
String message = LDAPToolUtils.getMessageForConnectionException(ae);
|
throw new IOException(message, ae);
|
}
|
else
|
{
|
printWrappedText(err, INFO_OPERATION_FAILED.get("COMPARE"));
|
printWrappedText(err, ae.getMessage());
|
return OPERATIONS_ERROR;
|
}
|
}
|
|
CompareResponseProtocolOp op =
|
responseMessage.getCompareResponseProtocolOp();
|
int resultCode = op.getResultCode();
|
LocalizableMessage errorMessage = op.getErrorMessage();
|
|
if(resultCode != COMPARE_TRUE && resultCode != COMPARE_FALSE
|
&& !compareOptions.continueOnError())
|
{
|
LocalizableMessage msg = INFO_OPERATION_FAILED.get("COMPARE");
|
throw new LDAPException(resultCode, errorMessage, msg,
|
op.getMatchedDN(), null);
|
} else
|
{
|
if(resultCode == COMPARE_FALSE)
|
{
|
if (isScriptFriendly())
|
{
|
out.println(line+": "+COMPARE_FALSE);
|
}
|
else
|
{
|
out.println(INFO_COMPARE_OPERATION_RESULT_FALSE.get(line));
|
}
|
} else if(resultCode == COMPARE_TRUE)
|
{
|
if (isScriptFriendly())
|
{
|
out.println(line+": "+COMPARE_TRUE);
|
}
|
else
|
{
|
out.println(INFO_COMPARE_OPERATION_RESULT_TRUE.get(line));
|
}
|
} else
|
{
|
LocalizableMessage msg = INFO_OPERATION_FAILED.get("COMPARE");
|
LDAPToolUtils.printErrorMessage(err, msg, resultCode, errorMessage,
|
op.getMatchedDN());
|
}
|
}
|
return resultCode;
|
}
|
return SUCCESS;
|
}
|
|
/**
|
* The main method for LDAPCompare tool.
|
*
|
* @param args The command-line arguments provided to this program.
|
*/
|
public static void main(String[] args)
|
{
|
int retCode = mainCompare(args, true, System.out, System.err);
|
if(retCode != 0)
|
{
|
System.exit(filterExitCode(retCode));
|
}
|
}
|
|
/**
|
* Parses the provided command-line arguments and uses that information to
|
* run the ldapcompare tool.
|
*
|
* @param args The command-line arguments provided to this program.
|
*
|
* @return The error code.
|
*/
|
public static int mainCompare(String[] args)
|
{
|
return mainCompare(args, true, System.out, System.err);
|
}
|
|
/**
|
* Parses the provided command-line arguments and uses that information to
|
* run the ldapcompare tool.
|
*
|
* @param args The command-line arguments provided to this
|
* program.
|
* @param initializeServer Indicates whether to initialize the server.
|
* @param outStream The output stream to use for standard output, or
|
* <CODE>null</CODE> if standard output is not
|
* needed.
|
* @param errStream The output stream to use for standard error, or
|
* <CODE>null</CODE> if standard error is not
|
* needed.
|
*
|
* @return The error code.
|
*/
|
public static int mainCompare(String[] args, boolean initializeServer,
|
OutputStream outStream, OutputStream errStream)
|
{
|
PrintStream out = NullOutputStream.wrapOrNullStream(outStream);
|
PrintStream err = NullOutputStream.wrapOrNullStream(errStream);
|
|
LDAPConnectionOptions connectionOptions = new LDAPConnectionOptions();
|
LDAPCompareOptions compareOptions = new LDAPCompareOptions();
|
LDAPConnection connection = null;
|
|
final BooleanArgument continueOnError;
|
final BooleanArgument noop;
|
final BooleanArgument saslExternal;
|
final BooleanArgument showUsage;
|
final BooleanArgument useCompareResultCode;
|
final BooleanArgument startTLS;
|
final BooleanArgument trustAll;
|
final BooleanArgument useSSL;
|
final BooleanArgument verbose;
|
final FileBasedArgument bindPasswordFile;
|
final FileBasedArgument keyStorePasswordFile;
|
final FileBasedArgument trustStorePasswordFile;
|
final IntegerArgument port;
|
final IntegerArgument version;
|
final StringArgument assertionFilter;
|
final StringArgument bindDN;
|
final StringArgument bindPassword;
|
final StringArgument certNickname;
|
final StringArgument controlStr;
|
final StringArgument encodingStr;
|
final StringArgument filename;
|
final StringArgument hostName;
|
final StringArgument keyStorePath;
|
final StringArgument keyStorePassword;
|
final StringArgument saslOptions;
|
final StringArgument trustStorePath;
|
final StringArgument trustStorePassword;
|
final IntegerArgument connectTimeout;
|
final StringArgument propertiesFileArgument;
|
final BooleanArgument noPropertiesFileArgument;
|
BooleanArgument scriptFriendlyArgument = null;
|
|
final List<String> dnStrings = new ArrayList<> ();
|
final String attributeType;
|
final byte[] attributeVal;
|
Reader rdr = null;
|
|
// Create the command-line argument parser for use with this program.
|
LocalizableMessage toolDescription = INFO_LDAPCOMPARE_TOOL_DESCRIPTION.get();
|
ArgumentParser argParser = new ArgumentParser(CLASS_NAME, toolDescription,
|
false, true, 1, 0,
|
" \'attribute:value\' \"DN\" ...");
|
argParser.setShortToolDescription(REF_SHORT_DESC_LDAPCOMPARE.get());
|
argParser.setVersionHandler(new DirectoryServerVersionHandler());
|
|
try
|
{
|
scriptFriendlyArgument =
|
BooleanArgument.builder("script-friendly")
|
.shortIdentifier('s')
|
.description(INFO_DESCRIPTION_SCRIPT_FRIENDLY.get())
|
.buildAndAddToParser(argParser);
|
propertiesFileArgument =
|
StringArgument.builder(OPTION_LONG_PROP_FILE_PATH)
|
.description(INFO_DESCRIPTION_PROP_FILE_PATH.get())
|
.valuePlaceholder(INFO_PROP_FILE_PATH_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
argParser.setFilePropertiesArgument(propertiesFileArgument);
|
|
noPropertiesFileArgument =
|
BooleanArgument.builder(OPTION_LONG_NO_PROP_FILE)
|
.description(INFO_DESCRIPTION_NO_PROP_FILE.get())
|
.buildAndAddToParser(argParser);
|
argParser.setNoPropertiesFileArgument(noPropertiesFileArgument);
|
|
hostName =
|
StringArgument.builder(OPTION_LONG_HOST)
|
.shortIdentifier(OPTION_SHORT_HOST)
|
.description(INFO_DESCRIPTION_HOST.get())
|
.defaultValue("localhost")
|
.valuePlaceholder(INFO_HOST_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
port =
|
IntegerArgument.builder(OPTION_LONG_PORT)
|
.shortIdentifier(OPTION_SHORT_PORT)
|
.description(INFO_DESCRIPTION_PORT.get())
|
.range(1, 65535)
|
.defaultValue(389)
|
.valuePlaceholder(INFO_PORT_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
useSSL =
|
BooleanArgument.builder(OPTION_LONG_USE_SSL)
|
.shortIdentifier(OPTION_SHORT_USE_SSL)
|
.description(INFO_DESCRIPTION_USE_SSL.get())
|
.buildAndAddToParser(argParser);
|
startTLS =
|
BooleanArgument.builder(OPTION_LONG_START_TLS)
|
.shortIdentifier(OPTION_SHORT_START_TLS)
|
.description(INFO_DESCRIPTION_START_TLS.get())
|
.buildAndAddToParser(argParser);
|
bindDN =
|
StringArgument.builder(OPTION_LONG_BINDDN)
|
.shortIdentifier(OPTION_SHORT_BINDDN)
|
.description(INFO_DESCRIPTION_BINDDN.get())
|
.valuePlaceholder(INFO_BINDDN_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
bindPassword =
|
StringArgument.builder(OPTION_LONG_BINDPWD)
|
.shortIdentifier(OPTION_SHORT_BINDPWD)
|
.description(INFO_DESCRIPTION_BINDPASSWORD.get())
|
.valuePlaceholder(INFO_BINDPWD_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
bindPasswordFile =
|
FileBasedArgument.builder(OPTION_LONG_BINDPWD_FILE)
|
.shortIdentifier(OPTION_SHORT_BINDPWD_FILE)
|
.description(INFO_DESCRIPTION_BINDPASSWORDFILE.get())
|
.valuePlaceholder(INFO_BINDPWD_FILE_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
filename =
|
StringArgument.builder(OPTION_LONG_FILENAME)
|
.shortIdentifier(OPTION_SHORT_FILENAME)
|
.description(INFO_COMPARE_DESCRIPTION_FILENAME.get())
|
.valuePlaceholder(INFO_FILE_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
saslExternal =
|
BooleanArgument.builder("useSASLExternal")
|
.shortIdentifier('r')
|
.description(INFO_DESCRIPTION_USE_SASL_EXTERNAL.get())
|
.buildAndAddToParser(argParser);
|
saslOptions =
|
StringArgument.builder(OPTION_LONG_SASLOPTION)
|
.shortIdentifier(OPTION_SHORT_SASLOPTION)
|
.description(INFO_DESCRIPTION_SASL_PROPERTIES.get())
|
.multiValued()
|
.valuePlaceholder(INFO_SASL_OPTION_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
|
trustAll = CommonArguments.getTrustAll();
|
argParser.addArgument(trustAll);
|
|
keyStorePath =
|
StringArgument.builder(OPTION_LONG_KEYSTOREPATH)
|
.shortIdentifier(OPTION_SHORT_KEYSTOREPATH)
|
.description(INFO_DESCRIPTION_KEYSTOREPATH.get())
|
.valuePlaceholder(INFO_KEYSTOREPATH_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
keyStorePassword =
|
StringArgument.builder(OPTION_LONG_KEYSTORE_PWD)
|
.shortIdentifier(OPTION_SHORT_KEYSTORE_PWD)
|
.description(INFO_DESCRIPTION_KEYSTOREPASSWORD.get())
|
.valuePlaceholder(INFO_KEYSTORE_PWD_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
keyStorePasswordFile =
|
FileBasedArgument.builder(OPTION_LONG_KEYSTORE_PWD_FILE)
|
.shortIdentifier(OPTION_SHORT_KEYSTORE_PWD_FILE)
|
.description(INFO_DESCRIPTION_KEYSTOREPASSWORD_FILE.get())
|
.valuePlaceholder(INFO_KEYSTORE_PWD_FILE_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
certNickname =
|
StringArgument.builder("certNickname")
|
.shortIdentifier('N')
|
.description(INFO_DESCRIPTION_CERT_NICKNAME.get())
|
.valuePlaceholder(INFO_NICKNAME_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
trustStorePath =
|
StringArgument.builder(OPTION_LONG_TRUSTSTOREPATH)
|
.shortIdentifier(OPTION_SHORT_TRUSTSTOREPATH)
|
.description(INFO_DESCRIPTION_TRUSTSTOREPATH.get())
|
.valuePlaceholder(INFO_TRUSTSTOREPATH_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
trustStorePassword =
|
StringArgument.builder(OPTION_LONG_TRUSTSTORE_PWD)
|
.description(INFO_DESCRIPTION_TRUSTSTOREPASSWORD.get())
|
.valuePlaceholder(INFO_TRUSTSTORE_PWD_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
trustStorePasswordFile =
|
FileBasedArgument.builder(OPTION_LONG_TRUSTSTORE_PWD_FILE)
|
.shortIdentifier(OPTION_SHORT_TRUSTSTORE_PWD_FILE)
|
.description(INFO_DESCRIPTION_TRUSTSTOREPASSWORD_FILE.get())
|
.valuePlaceholder(INFO_TRUSTSTORE_PWD_FILE_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
assertionFilter =
|
StringArgument.builder(OPTION_LONG_ASSERTION_FILE)
|
.description(INFO_DESCRIPTION_ASSERTION_FILTER.get())
|
.valuePlaceholder(INFO_ASSERTION_FILTER_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
controlStr =
|
StringArgument.builder("control")
|
.shortIdentifier('J')
|
.description(INFO_DESCRIPTION_CONTROLS.get())
|
.multiValued()
|
.valuePlaceholder(INFO_LDAP_CONTROL_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
version =
|
IntegerArgument.builder(OPTION_LONG_PROTOCOL_VERSION)
|
.shortIdentifier(OPTION_SHORT_PROTOCOL_VERSION)
|
.description(INFO_DESCRIPTION_VERSION.get())
|
.defaultValue(3)
|
.valuePlaceholder(INFO_PROTOCOL_VERSION_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
connectTimeout =
|
IntegerArgument.builder(OPTION_LONG_CONNECT_TIMEOUT)
|
.description(INFO_DESCRIPTION_CONNECTION_TIMEOUT.get())
|
.lowerBound(0)
|
.defaultValue(CliConstants.DEFAULT_LDAP_CONNECT_TIMEOUT)
|
.valuePlaceholder(INFO_TIMEOUT_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
encodingStr =
|
StringArgument.builder("encoding")
|
.shortIdentifier('i')
|
.description(INFO_DESCRIPTION_ENCODING.get())
|
.valuePlaceholder(INFO_ENCODING_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
continueOnError =
|
BooleanArgument.builder("continueOnError")
|
.shortIdentifier('c')
|
.description(INFO_DESCRIPTION_CONTINUE_ON_ERROR.get())
|
.buildAndAddToParser(argParser);
|
noop =
|
BooleanArgument.builder(OPTION_LONG_DRYRUN)
|
.shortIdentifier(OPTION_SHORT_DRYRUN)
|
.description(INFO_DESCRIPTION_NOOP.get())
|
.buildAndAddToParser(argParser);
|
|
verbose = CommonArguments.getVerbose();
|
argParser.addArgument(verbose);
|
|
showUsage = CommonArguments.getShowUsage();
|
argParser.addArgument(showUsage);
|
|
useCompareResultCode =
|
BooleanArgument.builder("useCompareResultCode")
|
.shortIdentifier('m')
|
.description(INFO_LDAPCOMPARE_DESCRIPTION_USE_COMPARE_RESULT.get())
|
.buildAndAddToParser(argParser);
|
|
argParser.setUsageArgument(showUsage, out);
|
} catch (ArgumentException ae)
|
{
|
printWrappedText(err, ERR_CANNOT_INITIALIZE_ARGS.get(ae.getMessage()));
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
|
// Parse the command-line arguments provided to this program.
|
try
|
{
|
argParser.parseArguments(args);
|
}
|
catch (ArgumentException ae)
|
{
|
argParser.displayMessageAndUsageReference(err, ERR_ERROR_PARSING_ARGS.get(ae.getMessage()));
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
|
// If we should just display usage or version information,
|
// then print it and exit.
|
if (argParser.usageOrVersionDisplayed())
|
{
|
return SUCCESS;
|
}
|
|
if(bindPassword.isPresent() && bindPasswordFile.isPresent())
|
{
|
printWrappedText(
|
err, ERR_TOOL_CONFLICTING_ARGS.get(bindPassword.getLongIdentifier(), bindPasswordFile.getLongIdentifier()));
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
|
ArrayList<String> attrAndDNStrings = argParser.getTrailingArguments();
|
|
if(attrAndDNStrings.isEmpty())
|
{
|
printWrappedText(err, ERR_LDAPCOMPARE_NO_ATTR.get());
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
|
// First element should be an attribute string.
|
String attributeString = attrAndDNStrings.remove(0);
|
// Rest are DN strings
|
dnStrings.addAll(attrAndDNStrings);
|
|
// If no DNs were provided, then exit with an error.
|
if (dnStrings.isEmpty() && !filename.isPresent())
|
{
|
printWrappedText(err, ERR_LDAPCOMPARE_NO_DNS.get());
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
|
// If trailing DNs were provided and the filename argument was also
|
// provided, exit with an error.
|
if (!dnStrings.isEmpty() && filename.isPresent())
|
{
|
printWrappedText(err, ERR_LDAPCOMPARE_FILENAME_AND_DNS.get());
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
|
// parse the attribute string
|
int idx = attributeString.indexOf(":");
|
if(idx == -1)
|
{
|
printWrappedText(err, ERR_LDAPCOMPARE_INVALID_ATTR_STRING.get(attributeString));
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
attributeType = attributeString.substring(0, idx);
|
String remainder = attributeString.substring(idx+1,
|
attributeString.length());
|
if (remainder.length() > 0)
|
{
|
char nextChar = remainder.charAt(0);
|
if(nextChar == ':')
|
{
|
String base64 = remainder.substring(1, remainder.length());
|
try
|
{
|
attributeVal = Base64.decode(base64);
|
}
|
catch (ParseException e)
|
{
|
printWrappedText(err, INFO_COMPARE_CANNOT_BASE64_DECODE_ASSERTION_VALUE.get());
|
printWrappedText(err, e.getLocalizedMessage());
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
} else if(nextChar == '<')
|
{
|
try
|
{
|
String filePath = remainder.substring(1, remainder.length());
|
attributeVal = LDAPToolUtils.readBytesFromFile(filePath, err);
|
}
|
catch (Exception e)
|
{
|
printWrappedText(err, INFO_COMPARE_CANNOT_READ_ASSERTION_VALUE_FROM_FILE.get(e));
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
} else
|
{
|
attributeVal = remainder.getBytes();
|
}
|
}
|
else
|
{
|
attributeVal = remainder.getBytes();
|
}
|
|
String hostNameValue = hostName.getValue();
|
int portNumber = 389;
|
try
|
{
|
portNumber = port.getIntValue();
|
} catch (ArgumentException ae)
|
{
|
argParser.displayMessageAndUsageReference(err, ae.getMessageObject());
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
|
try
|
{
|
int versionNumber = version.getIntValue();
|
if(versionNumber != 2 && versionNumber != 3)
|
{
|
printWrappedText(err, ERR_DESCRIPTION_INVALID_VERSION.get(versionNumber));
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
connectionOptions.setVersionNumber(versionNumber);
|
} catch(ArgumentException ae)
|
{
|
argParser.displayMessageAndUsageReference(err, ae.getMessageObject());
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
|
|
String bindDNValue = bindDN.getValue();
|
String fileNameValue = filename.getValue();
|
String bindPasswordValue;
|
try
|
{
|
bindPasswordValue = getPasswordValue(
|
bindPassword, bindPasswordFile, bindDNValue, out, err);
|
}
|
catch (ClientException ex)
|
{
|
printWrappedText(err, ex.getMessage());
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
|
String keyStorePathValue = keyStorePath.getValue();
|
String trustStorePathValue = trustStorePath.getValue();
|
|
String keyStorePasswordValue = null;
|
if (keyStorePassword.isPresent())
|
{
|
keyStorePasswordValue = keyStorePassword.getValue();
|
}
|
else if (keyStorePasswordFile.isPresent())
|
{
|
keyStorePasswordValue = keyStorePasswordFile.getValue();
|
}
|
|
String trustStorePasswordValue = null;
|
if (trustStorePassword.isPresent())
|
{
|
trustStorePasswordValue = trustStorePassword.getValue();
|
}
|
else if (trustStorePasswordFile.isPresent())
|
{
|
trustStorePasswordValue = trustStorePasswordFile.getValue();
|
}
|
|
compareOptions.setShowOperations(noop.isPresent());
|
compareOptions.setVerbose(verbose.isPresent());
|
compareOptions.setContinueOnError(continueOnError.isPresent());
|
compareOptions.setEncoding(encodingStr.getValue());
|
|
if(controlStr.isPresent())
|
{
|
for (String ctrlString : controlStr.getValues())
|
{
|
Control ctrl = LDAPToolUtils.getControl(ctrlString, err);
|
if(ctrl == null)
|
{
|
printWrappedText(err, ERR_TOOL_INVALID_CONTROL_STRING.get(ctrlString));
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
compareOptions.getControls().add(ctrl);
|
}
|
}
|
|
if (assertionFilter.isPresent())
|
{
|
String filterString = assertionFilter.getValue();
|
LDAPFilter filter;
|
try
|
{
|
filter = LDAPFilter.decode(filterString);
|
|
Control assertionControl =
|
new LDAPAssertionRequestControl(true, filter);
|
compareOptions.getControls().add(assertionControl);
|
}
|
catch (LDAPException le)
|
{
|
printWrappedText(err, ERR_LDAP_ASSERTION_INVALID_FILTER.get(le.getMessage()));
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
}
|
|
// Set the connection options.
|
// Parse the SASL properties.
|
connectionOptions.setSASLExternal(saslExternal.isPresent());
|
if(saslOptions.isPresent())
|
{
|
for (String saslOption : saslOptions.getValues())
|
{
|
boolean val;
|
if(saslOption.startsWith("mech="))
|
{
|
val = connectionOptions.setSASLMechanism(saslOption);
|
}
|
else
|
{
|
val = connectionOptions.addSASLProperty(saslOption);
|
}
|
if(!val)
|
{
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
}
|
}
|
connectionOptions.setUseSSL(useSSL.isPresent());
|
connectionOptions.setStartTLS(startTLS.isPresent());
|
|
if(connectionOptions.useSASLExternal())
|
{
|
if(!connectionOptions.useSSL() && !connectionOptions.useStartTLS())
|
{
|
printWrappedText(err, ERR_TOOL_SASLEXTERNAL_NEEDS_SSL_OR_TLS.get());
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
if(keyStorePathValue == null)
|
{
|
printWrappedText(err, ERR_TOOL_SASLEXTERNAL_NEEDS_KEYSTORE.get());
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
}
|
|
LDAPCompare ldapCompare = null;
|
try
|
{
|
if (initializeServer)
|
{
|
// Bootstrap and initialize directory data structures.
|
EmbeddedUtils.initializeForClientUse();
|
}
|
|
// Connect to the specified host with the supplied userDN and password.
|
SSLConnectionFactory sslConnectionFactory = null;
|
if(connectionOptions.useSSL() || connectionOptions.useStartTLS())
|
{
|
String clientAlias;
|
if (certNickname.isPresent())
|
{
|
clientAlias = certNickname.getValue();
|
}
|
else
|
{
|
clientAlias = null;
|
}
|
|
sslConnectionFactory = new SSLConnectionFactory();
|
sslConnectionFactory.init(trustAll.isPresent(), keyStorePathValue,
|
keyStorePasswordValue, clientAlias,
|
trustStorePathValue, trustStorePasswordValue);
|
connectionOptions.setSSLConnectionFactory(sslConnectionFactory);
|
}
|
|
AtomicInteger nextMessageID = new AtomicInteger(1);
|
connection = new LDAPConnection(hostNameValue, portNumber,
|
connectionOptions, out, err);
|
|
int timeout = connectTimeout.getIntValue();
|
connection.connectToHost(bindDNValue, bindPasswordValue, nextMessageID,
|
timeout);
|
|
ldapCompare = new LDAPCompare(nextMessageID, out, err);
|
ldapCompare.isScriptFriendly = scriptFriendlyArgument.isPresent();
|
if(fileNameValue == null && dnStrings.isEmpty())
|
{
|
// Read from stdin.
|
rdr = new InputStreamReader(System.in);
|
} else if(fileNameValue != null)
|
{
|
try
|
{
|
rdr = new FileReader(fileNameValue);
|
}
|
catch (Throwable t)
|
{
|
String details = t.getMessage();
|
if (details == null)
|
{
|
details = t.toString();
|
}
|
printWrappedText(err, ERR_LDAPCOMPARE_ERROR_READING_FILE.get(fileNameValue, details));
|
return CLIENT_SIDE_PARAM_ERROR;
|
}
|
}
|
int resultCode;
|
if(rdr != null)
|
{
|
resultCode =
|
ldapCompare.readAndExecute(connection, attributeType, attributeVal,
|
rdr, compareOptions);
|
} else
|
{
|
resultCode =
|
ldapCompare.readAndExecute(connection, attributeType, attributeVal,
|
dnStrings, compareOptions);
|
}
|
|
if (useCompareResultCode.isPresent())
|
{
|
return resultCode;
|
}
|
return SUCCESS;
|
} catch(LDAPException le)
|
{
|
LDAPToolUtils.printErrorMessage(
|
err, le.getMessageObject(),
|
le.getResultCode(),
|
le.getMessageObject(),
|
le.getMatchedDN());
|
return le.getResultCode();
|
} catch(LDAPConnectionException lce)
|
{
|
LDAPToolUtils.printErrorMessage(err,
|
lce.getMessageObject(),
|
lce.getResultCode(),
|
lce.getMessageObject(),
|
lce.getMatchedDN());
|
return lce.getResultCode();
|
} catch(Exception e)
|
{
|
printWrappedText(err, e.getMessage());
|
return OPERATIONS_ERROR;
|
} finally
|
{
|
if(connection != null)
|
{
|
if (ldapCompare != null)
|
{
|
connection.close(ldapCompare.nextMessageID);
|
}
|
else
|
{
|
connection.close(null);
|
}
|
}
|
}
|
}
|
|
private boolean isScriptFriendly()
|
{
|
return isScriptFriendly;
|
}
|
}
|
