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,
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);
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 0;
}
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();