/*
* 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
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
* 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
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. 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-2013 ForgeRock AS
*/
package org.opends.server.tools;
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.LinkedList;
import java.util.concurrent.atomic.AtomicInteger;
import org.opends.admin.ads.util.ConnectionUtils;
import org.opends.messages.Message;
import org.opends.server.controls.LDAPAssertionRequestControl;
import org.opends.server.loggers.debug.DebugTracer;
import org.opends.server.protocols.asn1.ASN1Exception;
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.*;
import org.opends.server.util.Base64;
import org.opends.server.util.EmbeddedUtils;
import org.opends.server.util.PasswordReader;
import org.opends.server.util.args.ArgumentException;
import org.opends.server.util.args.ArgumentParser;
import org.opends.server.util.args.BooleanArgument;
import org.opends.server.util.args.FileBasedArgument;
import org.opends.server.util.args.IntegerArgument;
import org.opends.server.util.args.StringArgument;
import static org.opends.messages.ToolMessages.*;
import static org.opends.server.loggers.debug.DebugLogger.*;
import static org.opends.server.protocols.ldap.LDAPResultCode.*;
import static org.opends.server.tools.ToolConstants.*;
import static org.opends.server.util.ServerConstants.*;
import static org.opends.server.util.StaticUtils.*;
/**
* This class provides a tool that can be used to issue compare requests to the
* Directory Server.
*/
public class LDAPCompare
{
/**
* The tracer object for the debug logger.
*/
private static final DebugTracer TRACER = getTracer();
/**
* 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, ArrayList<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.valueOf(line);
ByteString attrValOctetStr = ByteString.wrap(attributeVal);
ProtocolOp protocolOp = new CompareRequestProtocolOp(dnOctetStr,
attributeType, attrValOctetStr);
if (!isScriptFriendly())
{
out.println(INFO_PROCESSING_COMPARE_OPERATION.get(
attributeType, String.valueOf(attrValOctetStr),
String.valueOf(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(ASN1Exception ae)
{
if (debugEnabled())
{
TRACER.debugCaught(DebugLogLevel.ERROR, ae);
}
if (!compareOptions.continueOnError())
{
String message = LDAPToolUtils.getMessageForConnectionException(ae);
throw new IOException(message, ae);
}
else
{
Message msg = INFO_OPERATION_FAILED.get("COMPARE");
err.println(wrapText(msg, MAX_LINE_WIDTH));
err.println(wrapText(ae.getMessage(), MAX_LINE_WIDTH));
return OPERATIONS_ERROR;
}
}
CompareResponseProtocolOp op =
responseMessage.getCompareResponseProtocolOp();
int resultCode = op.getResultCode();
Message errorMessage = op.getErrorMessage();
if(resultCode != COMPARE_TRUE && resultCode != COMPARE_FALSE
&& !compareOptions.continueOnError())
{
Message 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
{
Message 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;
if (outStream == null)
{
out = NullOutputStream.printStream();
}
else
{
out = new PrintStream(outStream);
}
PrintStream err;
if (errStream == null)
{
err = NullOutputStream.printStream();
}
else
{
err = new PrintStream(errStream);
}
LDAPConnectionOptions connectionOptions = new LDAPConnectionOptions();
LDAPCompareOptions compareOptions = new LDAPCompareOptions();
LDAPConnection connection = null;
BooleanArgument continueOnError = null;
BooleanArgument noop = null;
BooleanArgument saslExternal = null;
BooleanArgument showUsage = null;
BooleanArgument useCompareResultCode = null;
BooleanArgument startTLS = null;
BooleanArgument trustAll = null;
BooleanArgument useSSL = null;
BooleanArgument verbose = null;
FileBasedArgument bindPasswordFile = null;
FileBasedArgument keyStorePasswordFile = null;
FileBasedArgument trustStorePasswordFile = null;
IntegerArgument port = null;
IntegerArgument version = null;
StringArgument assertionFilter = null;
StringArgument bindDN = null;
StringArgument bindPassword = null;
StringArgument certNickname = null;
StringArgument controlStr = null;
StringArgument encodingStr = null;
StringArgument filename = null;
StringArgument hostName = null;
StringArgument keyStorePath = null;
StringArgument keyStorePassword = null;
StringArgument saslOptions = null;
StringArgument trustStorePath = null;
StringArgument trustStorePassword = null;
IntegerArgument connectTimeout = null;
BooleanArgument scriptFriendlyArgument = null;
StringArgument propertiesFileArgument = null;
BooleanArgument noPropertiesFileArgument = null;
ArrayList<String> dnStrings = new ArrayList<String> ();
String attributeType = null;
byte[] attributeVal = null;
Reader rdr = null;
// Create the command-line argument parser for use with this program.
Message toolDescription = INFO_LDAPCOMPARE_TOOL_DESCRIPTION.get();
ArgumentParser argParser = new ArgumentParser(CLASS_NAME, toolDescription,
false, true, 1, 0,
" \'attribute:value\' \"DN\" ...");
try
{
scriptFriendlyArgument = new BooleanArgument(
"script-friendly",
's',
"script-friendly",
INFO_DESCRIPTION_SCRIPT_FRIENDLY.get());
scriptFriendlyArgument.setPropertyName(
scriptFriendlyArgument.getLongIdentifier());
argParser.addInputOutputArgument(scriptFriendlyArgument);
propertiesFileArgument = new StringArgument("propertiesFilePath",
null, OPTION_LONG_PROP_FILE_PATH,
false, false, true, INFO_PROP_FILE_PATH_PLACEHOLDER.get(), null, null,
INFO_DESCRIPTION_PROP_FILE_PATH.get());
argParser.addArgument(propertiesFileArgument);
argParser.setFilePropertiesArgument(propertiesFileArgument);
noPropertiesFileArgument = new BooleanArgument(
"noPropertiesFileArgument", null, OPTION_LONG_NO_PROP_FILE,
INFO_DESCRIPTION_NO_PROP_FILE.get());
argParser.addArgument(noPropertiesFileArgument);
argParser.setNoPropertiesFileArgument(noPropertiesFileArgument);
hostName = new StringArgument("host", OPTION_SHORT_HOST,
OPTION_LONG_HOST, false, false, true,
INFO_HOST_PLACEHOLDER.get(), "localhost",
null,
INFO_DESCRIPTION_HOST.get());
hostName.setPropertyName(OPTION_LONG_HOST);
argParser.addArgument(hostName);
port = new IntegerArgument("port", OPTION_SHORT_PORT,
OPTION_LONG_PORT, false, false, true,
INFO_PORT_PLACEHOLDER.get(), 389, null,
true, 1, true, 65535,
INFO_DESCRIPTION_PORT.get());
port.setPropertyName(OPTION_LONG_PORT);
argParser.addArgument(port);
useSSL = new BooleanArgument("useSSL", OPTION_SHORT_USE_SSL,
OPTION_LONG_USE_SSL,
INFO_DESCRIPTION_USE_SSL.get());
useSSL.setPropertyName(OPTION_LONG_USE_SSL);
argParser.addArgument(useSSL);
startTLS = new BooleanArgument("startTLS", OPTION_SHORT_START_TLS,
OPTION_LONG_START_TLS,
INFO_DESCRIPTION_START_TLS.get());
startTLS.setPropertyName(OPTION_LONG_START_TLS);
argParser.addArgument(startTLS);
bindDN = new StringArgument("bindDN", OPTION_SHORT_BINDDN,
OPTION_LONG_BINDDN, false, false, true,
INFO_BINDDN_PLACEHOLDER.get(), null, null,
INFO_DESCRIPTION_BINDDN.get());
bindDN.setPropertyName(OPTION_LONG_BINDDN);
argParser.addArgument(bindDN);
bindPassword = new StringArgument("bindPassword", OPTION_SHORT_BINDPWD,
OPTION_LONG_BINDPWD,
false, false, true,
INFO_BINDPWD_PLACEHOLDER.get(),
null, null,
INFO_DESCRIPTION_BINDPASSWORD.get());
bindPassword.setPropertyName(OPTION_LONG_BINDPWD);
argParser.addArgument(bindPassword);
bindPasswordFile =
new FileBasedArgument("bindPasswordFile",
OPTION_SHORT_BINDPWD_FILE,
OPTION_LONG_BINDPWD_FILE,
false, false,
INFO_BINDPWD_FILE_PLACEHOLDER.get(), null,
null, INFO_DESCRIPTION_BINDPASSWORDFILE.get());
bindPasswordFile.setPropertyName(OPTION_LONG_BINDPWD_FILE);
argParser.addArgument(bindPasswordFile);
filename = new StringArgument("filename", OPTION_SHORT_FILENAME,
OPTION_LONG_FILENAME, false, false,
true, INFO_FILE_PLACEHOLDER.get(), null,
null,
INFO_COMPARE_DESCRIPTION_FILENAME.get());
filename.setPropertyName(OPTION_LONG_FILENAME);
argParser.addArgument(filename);
saslExternal =
new BooleanArgument("useSASLExternal", 'r',
"useSASLExternal",
INFO_DESCRIPTION_USE_SASL_EXTERNAL.get());
saslExternal.setPropertyName("useSASLExternal");
argParser.addArgument(saslExternal);
saslOptions = new StringArgument("saslOption", OPTION_SHORT_SASLOPTION,
OPTION_LONG_SASLOPTION, false,
true, true,
INFO_SASL_OPTION_PLACEHOLDER.get(), null,
null,
INFO_DESCRIPTION_SASL_PROPERTIES.get());
saslOptions.setPropertyName(OPTION_LONG_SASLOPTION);
argParser.addArgument(saslOptions);
trustAll = new BooleanArgument("trustAll", 'X', "trustAll",
INFO_DESCRIPTION_TRUSTALL.get());
trustAll.setPropertyName("trustAll");
argParser.addArgument(trustAll);
keyStorePath = new StringArgument("keyStorePath",
OPTION_SHORT_KEYSTOREPATH,
OPTION_LONG_KEYSTOREPATH,
false, false, true,
INFO_KEYSTOREPATH_PLACEHOLDER.get(),
null, null,
INFO_DESCRIPTION_KEYSTOREPATH.get());
keyStorePath.setPropertyName(OPTION_LONG_KEYSTOREPATH);
argParser.addArgument(keyStorePath);
keyStorePassword = new StringArgument("keyStorePassword",
OPTION_SHORT_KEYSTORE_PWD,
OPTION_LONG_KEYSTORE_PWD, false, false,
true, INFO_KEYSTORE_PWD_PLACEHOLDER.get(),
null, null,
INFO_DESCRIPTION_KEYSTOREPASSWORD.get());
keyStorePassword.setPropertyName(OPTION_LONG_KEYSTORE_PWD);
argParser.addArgument(keyStorePassword);
keyStorePasswordFile =
new FileBasedArgument("keyStorePasswordFile",
OPTION_SHORT_KEYSTORE_PWD_FILE,
OPTION_LONG_KEYSTORE_PWD_FILE,
false, false,
INFO_KEYSTORE_PWD_FILE_PLACEHOLDER.get(),
null, null,
INFO_DESCRIPTION_KEYSTOREPASSWORD_FILE.get());
keyStorePasswordFile.setPropertyName(OPTION_LONG_KEYSTORE_PWD_FILE);
argParser.addArgument(keyStorePasswordFile);
certNickname =
new StringArgument("certnickname", 'N', "certNickname",
false, false, true,
INFO_NICKNAME_PLACEHOLDER.get(), null,
null, INFO_DESCRIPTION_CERT_NICKNAME.get());
certNickname.setPropertyName("certNickname");
argParser.addArgument(certNickname);
trustStorePath =
new StringArgument("trustStorePath",
OPTION_SHORT_TRUSTSTOREPATH,
OPTION_LONG_TRUSTSTOREPATH,
false, false, true,
INFO_TRUSTSTOREPATH_PLACEHOLDER.get(),
null, null,
INFO_DESCRIPTION_TRUSTSTOREPATH.get());
trustStorePath.setPropertyName(OPTION_LONG_TRUSTSTOREPATH);
argParser.addArgument(trustStorePath);
trustStorePassword =
new StringArgument("trustStorePassword", null,
OPTION_LONG_TRUSTSTORE_PWD,
false, false, true,
INFO_TRUSTSTORE_PWD_PLACEHOLDER.get(), null,
null, INFO_DESCRIPTION_TRUSTSTOREPASSWORD.get());
trustStorePassword.setPropertyName(OPTION_LONG_TRUSTSTORE_PWD);
argParser.addArgument(trustStorePassword);
trustStorePasswordFile =
new FileBasedArgument(
"trustStorePasswordFile",
OPTION_SHORT_TRUSTSTORE_PWD_FILE,
OPTION_LONG_TRUSTSTORE_PWD_FILE, false, false,
INFO_TRUSTSTORE_PWD_FILE_PLACEHOLDER.get(), null,
null,
INFO_DESCRIPTION_TRUSTSTOREPASSWORD_FILE.get());
trustStorePasswordFile.setPropertyName(OPTION_LONG_TRUSTSTORE_PWD_FILE);
argParser.addArgument(trustStorePasswordFile);
assertionFilter = new StringArgument("assertionfilter", null,
OPTION_LONG_ASSERTION_FILE, false, false, true,
INFO_ASSERTION_FILTER_PLACEHOLDER.get(), null,
null,
INFO_DESCRIPTION_ASSERTION_FILTER.get());
assertionFilter.setPropertyName(OPTION_LONG_ASSERTION_FILE);
argParser.addArgument(assertionFilter);
controlStr =
new StringArgument("control", 'J', "control", false, true, true,
INFO_LDAP_CONTROL_PLACEHOLDER.get(),
null, null, INFO_DESCRIPTION_CONTROLS.get());
controlStr.setPropertyName("control");
argParser.addArgument(controlStr);
version = new IntegerArgument("version", OPTION_SHORT_PROTOCOL_VERSION,
OPTION_LONG_PROTOCOL_VERSION,
false, false, true,
INFO_PROTOCOL_VERSION_PLACEHOLDER.get(),
3, null, INFO_DESCRIPTION_VERSION.get());
version.setPropertyName(OPTION_LONG_PROTOCOL_VERSION);
argParser.addArgument(version);
int defaultTimeout = ConnectionUtils.getDefaultLDAPTimeout();
connectTimeout = new IntegerArgument(OPTION_LONG_CONNECT_TIMEOUT,
null, OPTION_LONG_CONNECT_TIMEOUT,
false, false, true, INFO_TIMEOUT_PLACEHOLDER.get(),
defaultTimeout, null,
true, 0, false, Integer.MAX_VALUE,
INFO_DESCRIPTION_CONNECTION_TIMEOUT.get());
connectTimeout.setPropertyName(OPTION_LONG_CONNECT_TIMEOUT);
argParser.addArgument(connectTimeout);
encodingStr = new StringArgument("encoding", 'i', "encoding",
false, false,
true, INFO_ENCODING_PLACEHOLDER.get(),
null, null,
INFO_DESCRIPTION_ENCODING.get());
encodingStr.setPropertyName("encoding");
argParser.addArgument(encodingStr);
continueOnError = new BooleanArgument("continueOnError", 'c',
"continueOnError",
INFO_DESCRIPTION_CONTINUE_ON_ERROR.get());
continueOnError.setPropertyName("continueOnError");
argParser.addArgument(continueOnError);
noop = new BooleanArgument("no-op", OPTION_SHORT_DRYRUN,
OPTION_LONG_DRYRUN,
INFO_DESCRIPTION_NOOP.get());
argParser.addArgument(noop);
noop.setPropertyName(OPTION_LONG_DRYRUN);
verbose = new BooleanArgument("verbose", 'v', "verbose",
INFO_DESCRIPTION_VERBOSE.get());
verbose.setPropertyName("verbose");
argParser.addArgument(verbose);
showUsage = new BooleanArgument("showUsage", OPTION_SHORT_HELP,
OPTION_LONG_HELP,
INFO_DESCRIPTION_SHOWUSAGE.get());
argParser.addArgument(showUsage);
useCompareResultCode =
new BooleanArgument("usecompareresultcode", 'm',
"useCompareResultCode",
INFO_LDAPCOMPARE_DESCRIPTION_USE_COMPARE_RESULT.get());
argParser.addArgument(useCompareResultCode);
argParser.setUsageArgument(showUsage, out);
} catch (ArgumentException ae)
{
Message message = ERR_CANNOT_INITIALIZE_ARGS.get(ae.getMessage());
err.println(wrapText(message, MAX_LINE_WIDTH));
return CLIENT_SIDE_PARAM_ERROR;
}
// Parse the command-line arguments provided to this program.
try
{
argParser.parseArguments(args);
}
catch (ArgumentException ae)
{
Message message = ERR_ERROR_PARSING_ARGS.get(ae.getMessage());
err.println(wrapText(message, MAX_LINE_WIDTH));
err.println(argParser.getUsage());
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())
{
Message message = ERR_TOOL_CONFLICTING_ARGS.get(
bindPassword.getLongIdentifier(),
bindPasswordFile.getLongIdentifier());
err.println(wrapText(message, MAX_LINE_WIDTH));
return CLIENT_SIDE_PARAM_ERROR;
}
ArrayList<String> attrAndDNStrings = argParser.getTrailingArguments();
if(attrAndDNStrings.isEmpty())
{
Message message = ERR_LDAPCOMPARE_NO_ATTR.get();
err.println(wrapText(message, MAX_LINE_WIDTH));
return CLIENT_SIDE_PARAM_ERROR;
}
// First element should be an attribute string.
String attributeString = attrAndDNStrings.remove(0);
// Rest are DN strings
for(String s : attrAndDNStrings)
{
dnStrings.add(s);
}
// If no DNs were provided, then exit with an error.
if (dnStrings.isEmpty() && (! filename.isPresent()) )
{
err.println(wrapText(ERR_LDAPCOMPARE_NO_DNS.get(), MAX_LINE_WIDTH));
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())
{
err.println(wrapText(ERR_LDAPCOMPARE_FILENAME_AND_DNS.get(),
MAX_LINE_WIDTH));
return CLIENT_SIDE_PARAM_ERROR;
}
// parse the attribute string
int idx = attributeString.indexOf(":");
if(idx == -1)
{
Message message =
ERR_LDAPCOMPARE_INVALID_ATTR_STRING.get(attributeString);
err.println(wrapText(message, MAX_LINE_WIDTH));
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)
{
if (debugEnabled())
{
TRACER.debugCaught(DebugLogLevel.ERROR, e);
}
err.println(wrapText(
INFO_COMPARE_CANNOT_BASE64_DECODE_ASSERTION_VALUE.get(),
MAX_LINE_WIDTH));
return CLIENT_SIDE_PARAM_ERROR;
}
} else if(nextChar == '<')
{
try
{
String filePath = remainder.substring(1, remainder.length());
attributeVal = LDAPToolUtils.readBytesFromFile(filePath, err);
}
catch (Exception e)
{
err.println(wrapText(
INFO_COMPARE_CANNOT_READ_ASSERTION_VALUE_FROM_FILE.get(
String.valueOf(e)),
MAX_LINE_WIDTH));
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)
{
if (debugEnabled())
{
TRACER.debugCaught(DebugLogLevel.ERROR, ae);
}
err.println(wrapText(ae.getMessage(), MAX_LINE_WIDTH));
return CLIENT_SIDE_PARAM_ERROR;
}
try
{
int versionNumber = version.getIntValue();
if(versionNumber != 2 && versionNumber != 3)
{
err.println(wrapText(ERR_DESCRIPTION_INVALID_VERSION.get(
String.valueOf(versionNumber)), MAX_LINE_WIDTH));
return CLIENT_SIDE_PARAM_ERROR;
}
connectionOptions.setVersionNumber(versionNumber);
} catch(ArgumentException ae)
{
if (debugEnabled())
{
TRACER.debugCaught(DebugLogLevel.ERROR, ae);
}
err.println(wrapText(ae.getMessage(), MAX_LINE_WIDTH));
return CLIENT_SIDE_PARAM_ERROR;
}
String bindDNValue = bindDN.getValue();
String fileNameValue = filename.getValue();
String bindPasswordValue = bindPassword.getValue();
if(bindPasswordValue != null && bindPasswordValue.equals("-") ||
(!bindPasswordFile.isPresent() &&
(bindDNValue != null && bindPasswordValue == null)))
{
// read the password from the stdin.
try
{
out.print(INFO_LDAPAUTH_PASSWORD_PROMPT.get(bindDNValue));
char[] pwChars = PasswordReader.readPassword();
bindPasswordValue = new String(pwChars);
//As per rfc 4513(section-5.1.2) a client should avoid sending
//an empty password to the server.
while(pwChars.length==0)
{
err.println(wrapText(
INFO_LDAPAUTH_NON_EMPTY_PASSWORD.get(),
MAX_LINE_WIDTH));
out.print(INFO_LDAPAUTH_PASSWORD_PROMPT.get(bindDNValue));
pwChars = PasswordReader.readPassword();
}
bindPasswordValue = new String(pwChars);
} catch(Exception ex)
{
if (debugEnabled())
{
TRACER.debugCaught(DebugLogLevel.ERROR, ex);
}
err.println(wrapText(ex.getMessage(), MAX_LINE_WIDTH));
return CLIENT_SIDE_PARAM_ERROR;
}
} else if(bindPasswordValue == null)
{
// Read from file if it exists.
bindPasswordValue = bindPasswordFile.getValue();
}
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)
{
Message message = ERR_TOOL_INVALID_CONTROL_STRING.get(ctrlString);
err.println(wrapText(message, MAX_LINE_WIDTH));
err.println(argParser.getUsage());
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)
{
Message message = ERR_LDAP_ASSERTION_INVALID_FILTER.get(
le.getMessage());
err.println(wrapText(message, MAX_LINE_WIDTH));
return CLIENT_SIDE_PARAM_ERROR;
}
}
// Set the connection options.
// Parse the SASL properties.
connectionOptions.setSASLExternal(saslExternal.isPresent());
if(saslOptions.isPresent())
{
LinkedList<String> values = saslOptions.getValues();
for(String saslOption : values)
{
if(saslOption.startsWith("mech="))
{
boolean val = connectionOptions.setSASLMechanism(saslOption);
if(val == false)
{
return CLIENT_SIDE_PARAM_ERROR;
}
} else
{
boolean val = connectionOptions.addSASLProperty(saslOption);
if(val == false)
{
return CLIENT_SIDE_PARAM_ERROR;
}
}
}
}
connectionOptions.setUseSSL(useSSL.isPresent());
connectionOptions.setStartTLS(startTLS.isPresent());
if(connectionOptions.useSASLExternal())
{
if(!connectionOptions.useSSL() && !connectionOptions.useStartTLS())
{
Message message = ERR_TOOL_SASLEXTERNAL_NEEDS_SSL_OR_TLS.get();
err.println(wrapText(message, MAX_LINE_WIDTH));
return CLIENT_SIDE_PARAM_ERROR;
}
if(keyStorePathValue == null)
{
Message message = ERR_TOOL_SASLEXTERNAL_NEEDS_KEYSTORE.get();
err.println(wrapText(message, MAX_LINE_WIDTH));
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)
{
if (debugEnabled())
{
TRACER.debugCaught(DebugLogLevel.ERROR, t);
}
String details = t.getMessage();
if (details == null)
{
details = t.toString();
}
err.println(wrapText(ERR_LDAPCOMPARE_ERROR_READING_FILE.get(
fileNameValue, details), MAX_LINE_WIDTH));
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)
{
if (debugEnabled())
{
TRACER.debugCaught(DebugLogLevel.ERROR, le);
}
LDAPToolUtils.printErrorMessage(
err, le.getMessageObject(),
le.getResultCode(),
le.getMessageObject(),
le.getMatchedDN());
int code = le.getResultCode();
return code;
} catch(LDAPConnectionException lce)
{
if (debugEnabled())
{
TRACER.debugCaught(DebugLogLevel.ERROR, lce);
}
LDAPToolUtils.printErrorMessage(err,
lce.getMessageObject(),
lce.getResultCode(),
lce.getMessageObject(),
lce.getMatchedDN());
int code = lce.getResultCode();
return code;
} catch(Exception e)
{
if (debugEnabled())
{
TRACER.debugCaught(DebugLogLevel.ERROR, e);
}
err.println(wrapText(e.getMessage(), MAX_LINE_WIDTH));
return OPERATIONS_ERROR;
} finally
{
if(connection != null)
{
if (ldapCompare == null)
{
connection.close(null);
}
else
{
connection.close(ldapCompare.nextMessageID);
}
}
}
}
private boolean isScriptFriendly()
{
return isScriptFriendly;
}
}