/* * 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 * * * Portions Copyright 2006-2007 Sun Microsystems, Inc. */ package org.opends.server.tools; import java.io.BufferedReader; import java.io.FileReader; import java.io.IOException; import java.io.OutputStream; import java.io.PrintStream; import java.util.ArrayList; import java.util.HashSet; import java.util.LinkedHashSet; import java.util.LinkedList; import java.util.StringTokenizer; import java.util.concurrent.atomic.AtomicInteger; import org.opends.server.controls.AccountUsableResponseControl; import org.opends.server.controls.EntryChangeNotificationControl; import org.opends.server.controls.MatchedValuesControl; import org.opends.server.controls.MatchedValuesFilter; import org.opends.server.controls.PagedResultsControl; import org.opends.server.controls.PersistentSearchChangeType; import org.opends.server.controls.PersistentSearchControl; import org.opends.server.core.DirectoryServer; import org.opends.server.util.Base64; 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 org.opends.server.protocols.asn1.ASN1Element; import org.opends.server.protocols.asn1.ASN1Exception; import org.opends.server.protocols.asn1.ASN1OctetString; import org.opends.server.protocols.asn1.ASN1Sequence; import org.opends.server.protocols.ldap.LDAPAttribute; import org.opends.server.protocols.ldap.LDAPControl; import org.opends.server.protocols.ldap.LDAPException; import org.opends.server.protocols.ldap.LDAPFilter; import org.opends.server.protocols.ldap.LDAPMessage; import org.opends.server.protocols.ldap.SearchRequestProtocolOp; import org.opends.server.protocols.ldap.SearchResultDoneProtocolOp; import org.opends.server.protocols.ldap.SearchResultEntryProtocolOp; import org.opends.server.protocols.ldap.SearchResultReferenceProtocolOp; import org.opends.server.types.DN; import org.opends.server.types.NullOutputStream; import org.opends.server.types.DebugLogLevel; import static org.opends.server.loggers.debug.DebugLogger.debugCaught; import static org.opends.server.loggers.debug.DebugLogger.debugEnabled; import static org.opends.server.messages.MessageHandler.*; import static org.opends.server.messages.ToolMessages.*; import static org.opends.server.protocols.ldap.LDAPConstants.*; import static org.opends.server.protocols.ldap.LDAPResultCode.*; 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 search requests to the * Directory Server. */ public class LDAPSearch { /** * The fully-qualified name of this class. */ private static final String CLASS_NAME = "org.opends.server.tools.LDAPSearch"; // The set of response controls for the search. private ArrayList responseControls; // The message ID counter to use for requests. private AtomicInteger nextMessageID; // The print stream to use for standard error. private PrintStream err; // The print stream to use for standard output. private PrintStream out; /** * Constructor for the LDAPSearch 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 LDAPSearch(AtomicInteger nextMessageID, PrintStream out, PrintStream err) { this.nextMessageID = nextMessageID; this.out = out; this.err = err; responseControls = new ArrayList(); } /** * Execute the search based on the specified input parameters. * * @param connection The connection to use for the search. * @param baseDN The base DN for the search request. * @param filters The filters to use for the results. * @param attributes The attributes to return in the results. * @param searchOptions The constraints for the search. * @param wrapColumn The column at which to wrap long lines. * * @return The number of matching entries returned by the server. If there * were multiple search filters provided, then this will be the * total number of matching entries for all searches. * * @throws IOException If a problem occurs while attempting to communicate * with the Directory Server. * * @throws LDAPException If the Directory Server returns an error response. */ public int executeSearch(LDAPConnection connection, String baseDN, ArrayList filters, LinkedHashSet attributes, LDAPSearchOptions searchOptions, int wrapColumn ) throws IOException, LDAPException { int matchingEntries = 0; for (LDAPFilter filter: filters) { ASN1OctetString asn1OctetStr = new ASN1OctetString(baseDN); SearchRequestProtocolOp protocolOp = new SearchRequestProtocolOp(asn1OctetStr, searchOptions.getSearchScope(), searchOptions.getDereferencePolicy(), searchOptions.getSizeLimit(), searchOptions.getTimeLimit(), false, filter, attributes); if(!searchOptions.showOperations()) { try { boolean typesOnly = searchOptions.getTypesOnly(); LDAPMessage message = new LDAPMessage(nextMessageID.getAndIncrement(), protocolOp, searchOptions.getControls()); connection.getASN1Writer().writeElement(message.encode()); byte opType; do { int resultCode = 0; String errorMessage = null; ASN1Element element = connection.getASN1Reader().readElement(); LDAPMessage responseMessage = LDAPMessage.decode(ASN1Sequence.decodeAsSequence(element)); responseControls = responseMessage.getControls(); opType = responseMessage.getProtocolOpType(); switch(opType) { case OP_TYPE_SEARCH_RESULT_ENTRY: for (LDAPControl c : responseControls) { if (c.getOID().equals(OID_ENTRY_CHANGE_NOTIFICATION)) { try { EntryChangeNotificationControl ecn = EntryChangeNotificationControl.decodeControl( c.getControl()); int msgID = MSGID_LDAPSEARCH_PSEARCH_CHANGE_TYPE; out.println(getMessage(msgID, ecn.getChangeType().toString())); DN previousDN = ecn.getPreviousDN(); if (previousDN != null) { msgID = MSGID_LDAPSEARCH_PSEARCH_PREVIOUS_DN; out.println(getMessage(msgID, previousDN.toString())); } } catch (Exception e) {} } else if (c.getOID().equals(OID_ACCOUNT_USABLE_CONTROL)) { try { AccountUsableResponseControl acrc = AccountUsableResponseControl.decodeControl( c.getControl()); int msgID = MSGID_LDAPSEARCH_ACCTUSABLE_HEADER; out.println(getMessage(msgID)); if (acrc.isUsable()) { msgID = MSGID_LDAPSEARCH_ACCTUSABLE_IS_USABLE; out.println(getMessage(msgID)); if (acrc.getSecondsBeforeExpiration() > 0) { int timeToExp = acrc.getSecondsBeforeExpiration(); String timeToExpStr = secondsToTimeString(timeToExp); msgID = MSGID_LDAPSEARCH_ACCTUSABLE_TIME_UNTIL_EXPIRATION; out.println(getMessage(msgID, timeToExpStr)); } } else { msgID = MSGID_LDAPSEARCH_ACCTUSABLE_NOT_USABLE; out.println(getMessage(msgID)); if (acrc.isInactive()) { msgID = MSGID_LDAPSEARCH_ACCTUSABLE_ACCT_INACTIVE; out.println(getMessage(msgID)); } if (acrc.isReset()) { msgID = MSGID_LDAPSEARCH_ACCTUSABLE_PW_RESET; out.println(getMessage(msgID)); } if (acrc.isExpired()) { msgID = MSGID_LDAPSEARCH_ACCTUSABLE_PW_EXPIRED; out.println(getMessage(msgID)); if (acrc.getRemainingGraceLogins() > 0) { msgID = MSGID_LDAPSEARCH_ACCTUSABLE_REMAINING_GRACE; out.println(getMessage(msgID, acrc.getRemainingGraceLogins())); } } if (acrc.isLocked()) { msgID = MSGID_LDAPSEARCH_ACCTUSABLE_LOCKED; out.println(getMessage(msgID)); if (acrc.getSecondsBeforeUnlock() > 0) { int timeToUnlock = acrc.getSecondsBeforeUnlock(); String timeToUnlockStr = secondsToTimeString(timeToUnlock); msgID = MSGID_LDAPSEARCH_ACCTUSABLE_TIME_UNTIL_UNLOCK; out.println(getMessage(msgID, timeToUnlockStr)); } } } } catch (Exception e) {} } } SearchResultEntryProtocolOp searchEntryOp = responseMessage.getSearchResultEntryProtocolOp(); StringBuilder sb = new StringBuilder(); toLDIF(searchEntryOp, sb, wrapColumn, typesOnly); out.print(sb.toString()); matchingEntries++; break; case OP_TYPE_SEARCH_RESULT_REFERENCE: SearchResultReferenceProtocolOp searchRefOp = responseMessage.getSearchResultReferenceProtocolOp(); out.println(searchRefOp.toString()); break; case OP_TYPE_SEARCH_RESULT_DONE: SearchResultDoneProtocolOp searchOp = responseMessage.getSearchResultDoneProtocolOp(); resultCode = searchOp.getResultCode(); errorMessage = searchOp.getErrorMessage(); break; default: // FIXME - throw exception? int msgID = MSGID_SEARCH_OPERATION_INVALID_PROTOCOL; String msg = getMessage(msgID, opType); err.println(wrapText(msg, MAX_LINE_WIDTH)); break; } if(resultCode != SUCCESS && resultCode != REFERRAL) { int msgID = MSGID_OPERATION_FAILED; if(errorMessage == null) { errorMessage = "Result Code:" + resultCode; } throw new LDAPException(resultCode, msgID, errorMessage); } else if (errorMessage != null) { out.println(); out.println(wrapText(errorMessage, MAX_LINE_WIDTH)); } } while(opType != OP_TYPE_SEARCH_RESULT_DONE); } catch(ASN1Exception ae) { if (debugEnabled()) { debugCaught(DebugLogLevel.ERROR, ae); } throw new IOException(ae.getMessage()); } } } if (searchOptions.countMatchingEntries()) { int msgID = MSGID_LDAPSEARCH_MATCHING_ENTRY_COUNT; String message = getMessage(msgID, matchingEntries); out.println(message); out.println(); } return matchingEntries; } /** * Appends an LDIF representation of the entry to the provided buffer. * * @param entry The entry to be written as LDIF. * @param buffer The buffer to which the entry should be appended. * @param wrapColumn The column at which long lines should be wrapped. * @param typesOnly Indicates whether to include only attribute types * without values. */ public void toLDIF(SearchResultEntryProtocolOp entry, StringBuilder buffer, int wrapColumn, boolean typesOnly) { // Add the DN to the buffer. String dnString = entry.getDN().toString(); int colsRemaining; if (needsBase64Encoding(dnString)) { dnString = Base64.encode(getBytes(dnString)); buffer.append("dn:: "); colsRemaining = wrapColumn - 5; } else { buffer.append("dn: "); colsRemaining = wrapColumn - 4; } int dnLength = dnString.length(); if ((dnLength <= colsRemaining) || (colsRemaining <= 0)) { buffer.append(dnString); buffer.append(EOL); } else { buffer.append(dnString.substring(0, colsRemaining)); buffer.append(EOL); int startPos = colsRemaining; while ((dnLength - startPos) > (wrapColumn - 1)) { buffer.append(" "); buffer.append(dnString.substring(startPos, (startPos+wrapColumn-1))); buffer.append(EOL); startPos += (wrapColumn-1); } if (startPos < dnLength) { buffer.append(" "); buffer.append(dnString.substring(startPos)); buffer.append(EOL); } } LinkedList attributes = entry.getAttributes(); // Add the attributes to the buffer. for (LDAPAttribute a : attributes) { String name = a.getAttributeType(); int nameLength = name.length(); if(typesOnly) { buffer.append(name); buffer.append(EOL); } else { for (ASN1OctetString v : a.getValues()) { String valueString; if (needsBase64Encoding(v.value())) { valueString = Base64.encode(v.value()); buffer.append(name); buffer.append(":: "); colsRemaining = wrapColumn - nameLength - 3; } else { valueString = v.stringValue(); buffer.append(name); buffer.append(": "); colsRemaining = wrapColumn - nameLength - 2; } int valueLength = valueString.length(); if ((valueLength <= colsRemaining) || (colsRemaining <= 0)) { buffer.append(valueString); buffer.append(EOL); } else { buffer.append(valueString.substring(0, colsRemaining)); buffer.append(EOL); int startPos = colsRemaining; while ((valueLength - startPos) > (wrapColumn - 1)) { buffer.append(" "); buffer.append(valueString.substring(startPos, (startPos+wrapColumn-1))); buffer.append(EOL); startPos += (wrapColumn-1); } if (startPos < valueLength) { buffer.append(" "); buffer.append(valueString.substring(startPos)); buffer.append(EOL); } } } } } // Make sure to add an extra blank line to ensure that there will be one // between this entry and the next. buffer.append(EOL); } /** * Retrieves the set of response controls included in the last search result * done message. * * @return The set of response controls included in the last search result * done message. */ public ArrayList getResponseControls() { return responseControls; } /** * The main method for LDAPSearch tool. * * @param args The command-line arguments provided to this program. */ public static void main(String[] args) { int retCode = mainSearch(args, true, System.out, System.err); if(retCode != 0) { System.exit(retCode); } } /** * Parses the provided command-line arguments and uses that information to * run the ldapsearch tool. * * @param args The command-line arguments provided to this program. * * @return The error code. */ public static int mainSearch(String[] args) { return mainSearch(args, true, System.out, System.err); } /** * Parses the provided command-line arguments and uses that information to * run the ldapsearch 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 * null if standard output is not * needed. * @param errStream The output stream to use for standard error, or * null if standard error is not * needed. * * @return The error code. */ public static int mainSearch(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(); LDAPSearchOptions searchOptions = new LDAPSearchOptions(); LDAPConnection connection = null; ArrayList filters = new ArrayList(); LinkedHashSet attributes = new LinkedHashSet(); BooleanArgument continueOnError = null; BooleanArgument countEntries = null; BooleanArgument dontWrap = null; BooleanArgument noop = null; BooleanArgument reportAuthzID = null; BooleanArgument saslExternal = null; BooleanArgument showUsage = null; BooleanArgument trustAll = null; BooleanArgument usePasswordPolicyControl = null; BooleanArgument useSSL = null; BooleanArgument startTLS = null; BooleanArgument typesOnly = null; BooleanArgument verbose = null; FileBasedArgument bindPasswordFile = null; FileBasedArgument keyStorePasswordFile = null; FileBasedArgument trustStorePasswordFile = null; IntegerArgument port = null; IntegerArgument simplePageSize = null; IntegerArgument sizeLimit = null; IntegerArgument timeLimit = null; IntegerArgument version = null; StringArgument assertionFilter = null; StringArgument baseDN = null; StringArgument bindDN = null; StringArgument bindPassword = null; StringArgument certNickname = null; StringArgument controlStr = null; StringArgument dereferencePolicy = null; StringArgument encodingStr = null; StringArgument filename = null; StringArgument hostName = null; StringArgument keyStorePath = null; StringArgument keyStorePassword = null; StringArgument matchedValuesFilter = null; StringArgument proxyAuthzID = null; StringArgument pSearchInfo = null; StringArgument saslOptions = null; StringArgument searchScope = null; StringArgument trustStorePath = null; StringArgument trustStorePassword = null; // Create the command-line argument parser for use with this program. String toolDescription = getMessage(MSGID_LDAPSEARCH_TOOL_DESCRIPTION); ArgumentParser argParser = new ArgumentParser(CLASS_NAME, toolDescription, false, true, 0, 0, "[filter] [attributes ...]"); try { hostName = new StringArgument("host", 'h', "host", false, false, true, "{host}", "localhost", null, MSGID_DESCRIPTION_HOST); argParser.addArgument(hostName); port = new IntegerArgument("port", 'p', "port", false, false, true, "{port}", 389, null, MSGID_DESCRIPTION_PORT); argParser.addArgument(port); useSSL = new BooleanArgument("useSSL", 'Z', "useSSL", MSGID_DESCRIPTION_USE_SSL); argParser.addArgument(useSSL); startTLS = new BooleanArgument("startTLS", 'q', "startTLS", MSGID_DESCRIPTION_START_TLS); argParser.addArgument(startTLS); bindDN = new StringArgument("bindDN", 'D', "bindDN", false, false, true, "{bindDN}", null, null, MSGID_DESCRIPTION_BINDDN); argParser.addArgument(bindDN); bindPassword = new StringArgument("bindPassword", 'w', "bindPassword", false, false, true, "{bindPassword}", null, null, MSGID_DESCRIPTION_BINDPASSWORD); argParser.addArgument(bindPassword); bindPasswordFile = new FileBasedArgument("bindPasswordFile", 'j', "bindPasswordFile", false, false, "{bindPasswordFilename}", null, null, MSGID_DESCRIPTION_BINDPASSWORDFILE); argParser.addArgument(bindPasswordFile); baseDN = new StringArgument("baseDN", 'b', "baseDN", true, false, true, "{baseDN}", null, null, MSGID_SEARCH_DESCRIPTION_BASEDN); argParser.addArgument(baseDN); searchScope = new StringArgument("searchScope", 's', "searchScope", false, false, true, "{searchScope}", null, null, MSGID_SEARCH_DESCRIPTION_SEARCH_SCOPE); argParser.addArgument(searchScope); filename = new StringArgument("filename", 'f', "filename", false, false, true, "{filename}", null, null, MSGID_SEARCH_DESCRIPTION_FILENAME); argParser.addArgument(filename); saslExternal = new BooleanArgument("useSASLExternal", 'r', "useSASLExternal", MSGID_DESCRIPTION_USE_SASL_EXTERNAL); argParser.addArgument(saslExternal); saslOptions = new StringArgument("saslOption", 'o', "saslOption", false, true, true, "{name=value}", null, null, MSGID_DESCRIPTION_SASL_PROPERTIES); argParser.addArgument(saslOptions); trustAll = new BooleanArgument("trustAll", 'X', "trustAll", MSGID_DESCRIPTION_TRUSTALL); argParser.addArgument(trustAll); keyStorePath = new StringArgument("keyStorePath", 'K', "keyStorePath", false, false, true, "{keyStorePath}", null, null, MSGID_DESCRIPTION_KEYSTOREPATH); argParser.addArgument(keyStorePath); keyStorePassword = new StringArgument("keyStorePassword", 'W', "keyStorePassword", false, false, true, "{keyStorePassword}", null, null, MSGID_DESCRIPTION_KEYSTOREPASSWORD); argParser.addArgument(keyStorePassword); keyStorePasswordFile = new FileBasedArgument("keystorepasswordfile", null, "keyStorePasswordFile", false, false, "{path}", null, null, MSGID_DESCRIPTION_KEYSTOREPASSWORD_FILE); argParser.addArgument(keyStorePasswordFile); certNickname = new StringArgument("certnickname", 'N', "certNickname", false, false, true, "{nickname}", null, null, MSGID_DESCRIPTION_CERT_NICKNAME); argParser.addArgument(certNickname); trustStorePath = new StringArgument("trustStorePath", 'P', "trustStorePath", false, false, true, "{trustStorePath}", null, null, MSGID_DESCRIPTION_TRUSTSTOREPATH); argParser.addArgument(trustStorePath); trustStorePassword = new StringArgument("trustStorePassword", null, "trustStorePassword", false, false, true, "{trustStorePassword}", null, null, MSGID_DESCRIPTION_TRUSTSTOREPASSWORD); argParser.addArgument(trustStorePassword); trustStorePasswordFile = new FileBasedArgument("truststorepasswordfile", null, "trustStorePasswordFile", false, false, "{path}", null, null, MSGID_DESCRIPTION_TRUSTSTOREPASSWORD_FILE); argParser.addArgument(trustStorePasswordFile); proxyAuthzID = new StringArgument("proxy_authzid", 'Y', "proxyAs", false, false, true, "{authzID}", null, null, MSGID_DESCRIPTION_PROXY_AUTHZID); argParser.addArgument(proxyAuthzID); reportAuthzID = new BooleanArgument("reportauthzid", 'E', "reportAuthzID", MSGID_DESCRIPTION_REPORT_AUTHZID); argParser.addArgument(reportAuthzID); usePasswordPolicyControl = new BooleanArgument("usepwpolicycontrol", null, "usePasswordPolicyControl", MSGID_DESCRIPTION_USE_PWP_CONTROL); argParser.addArgument(usePasswordPolicyControl); pSearchInfo = new StringArgument("psearchinfo", 'C', "persistentSearch", false, false, true, "ps[:changetype[:changesonly[:entrychgcontrols]]]", null, null, MSGID_DESCRIPTION_PSEARCH_INFO); argParser.addArgument(pSearchInfo); simplePageSize = new IntegerArgument("simplepagesize", null, "simplePageSize", false, false, true, "{numEntries}", 1000, null, true, 1, false, 0, MSGID_DESCRIPTION_SIMPLE_PAGE_SIZE); argParser.addArgument(simplePageSize); assertionFilter = new StringArgument("assertionfilter", null, "assertionFilter", false, false, true, "{filter}", null, null, MSGID_DESCRIPTION_ASSERTION_FILTER); argParser.addArgument(assertionFilter); matchedValuesFilter = new StringArgument("matchedvalues", null, "matchedValuesFilter", false, true, true, "{filter}", null, null, MSGID_DESCRIPTION_MATCHED_VALUES_FILTER); argParser.addArgument(matchedValuesFilter); controlStr = new StringArgument("control", 'J', "control", false, true, true, "{controloid[:criticality[:value|::b64value|: filterAndAttributeStrings = argParser.getTrailingArguments(); if(filterAndAttributeStrings.size() > 0) { String filterString = filterAndAttributeStrings.remove(0); try { filters.add(LDAPFilter.decode(filterString)); } catch(LDAPException le) { if (debugEnabled()) { debugCaught(DebugLogLevel.ERROR, le); } err.println(wrapText(le.getMessage(), MAX_LINE_WIDTH)); return 1; } // The rest are attributes for(String s : filterAndAttributeStrings) { attributes.add(s); } } if(bindPassword.isPresent() && bindPasswordFile.isPresent()) { int msgID = MSGID_TOOL_CONFLICTING_ARGS; String message = getMessage(msgID, bindPassword.getLongIdentifier(), bindPasswordFile.getLongIdentifier()); err.println(wrapText(message, MAX_LINE_WIDTH)); return 1; } if (useSSL.isPresent() && startTLS.isPresent()) { int msgID = MSGID_TOOL_CONFLICTING_ARGS; String message = getMessage(msgID, useSSL.getLongIdentifier(), startTLS.getLongIdentifier()); err.println(wrapText(message, MAX_LINE_WIDTH)); return 1; } if (keyStorePassword.isPresent() && keyStorePasswordFile.isPresent()) { int msgID = MSGID_TOOL_CONFLICTING_ARGS; String message = getMessage(msgID, keyStorePassword.getLongIdentifier(), keyStorePasswordFile.getLongIdentifier()); err.println(wrapText(message, MAX_LINE_WIDTH)); return 1; } if (trustStorePassword.isPresent() && trustStorePasswordFile.isPresent()) { int msgID = MSGID_TOOL_CONFLICTING_ARGS; String message = getMessage(msgID, trustStorePassword.getLongIdentifier(), trustStorePasswordFile.getLongIdentifier()); err.println(wrapText(message, MAX_LINE_WIDTH)); return 1; } String hostNameValue = hostName.getValue(); int portNumber = 389; try { portNumber = port.getIntValue(); } catch(ArgumentException ae) { if (debugEnabled()) { debugCaught(DebugLogLevel.ERROR, ae); } err.println(wrapText(ae.getMessage(), MAX_LINE_WIDTH)); return 1; } // Read the LDAP version number. try { int versionNumber = version.getIntValue(); if(versionNumber != 2 && versionNumber != 3) { int msgID = MSGID_DESCRIPTION_INVALID_VERSION; err.println(wrapText(getMessage(msgID, versionNumber), MAX_LINE_WIDTH)); return 1; } connectionOptions.setVersionNumber(versionNumber); } catch(ArgumentException ae) { if (debugEnabled()) { debugCaught(DebugLogLevel.ERROR, ae); } err.println(wrapText(ae.getMessage(), MAX_LINE_WIDTH)); return 1; } // Indicate whether we should report the authorization ID and/or use the // password policy control. connectionOptions.setReportAuthzID(reportAuthzID.isPresent()); connectionOptions.setUsePasswordPolicyControl( usePasswordPolicyControl.isPresent()); String baseDNValue = baseDN.getValue(); String bindDNValue = bindDN.getValue(); String fileNameValue = filename.getValue(); String bindPasswordValue = bindPassword.getValue(); if(bindPasswordValue != null && bindPasswordValue.equals("-")) { // read the password from the stdin. try { out.print(getMessage(MSGID_LDAPAUTH_PASSWORD_PROMPT, bindDNValue)); char[] pwChars = PasswordReader.readPassword(); bindPasswordValue = new String(pwChars); } catch(Exception ex) { if (debugEnabled()) { debugCaught(DebugLogLevel.ERROR, ex); } err.println(wrapText(ex.getMessage(), MAX_LINE_WIDTH)); return 1; } } 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(); } searchOptions.setTypesOnly(typesOnly.isPresent()); searchOptions.setShowOperations(noop.isPresent()); searchOptions.setVerbose(verbose.isPresent()); searchOptions.setContinueOnError(continueOnError.isPresent()); searchOptions.setEncoding(encodingStr.getValue()); searchOptions.setCountMatchingEntries(countEntries.isPresent()); try { searchOptions.setTimeLimit(timeLimit.getIntValue()); searchOptions.setSizeLimit(sizeLimit.getIntValue()); } catch(ArgumentException ex1) { err.println(wrapText(ex1.getMessage(), MAX_LINE_WIDTH)); return 1; } boolean val = searchOptions.setSearchScope(searchScope.getValue(), err); if(val == false) { return 1; } val = searchOptions.setDereferencePolicy(dereferencePolicy.getValue(), err); if(val == false) { return 1; } if(controlStr.isPresent()) { for (String ctrlString : controlStr.getValues()) { LDAPControl ctrl = LDAPToolUtils.getControl(ctrlString, err); if(ctrl == null) { int msgID = MSGID_TOOL_INVALID_CONTROL_STRING; String message = getMessage(msgID, ctrlString); err.println(wrapText(message, MAX_LINE_WIDTH)); err.println(argParser.getUsage()); return 1; } searchOptions.getControls().add(ctrl); } } if (proxyAuthzID.isPresent()) { ASN1OctetString proxyValue = new ASN1OctetString(proxyAuthzID.getValue()); LDAPControl proxyControl = new LDAPControl(OID_PROXIED_AUTH_V2, true, proxyValue); searchOptions.getControls().add(proxyControl); } if (pSearchInfo.isPresent()) { String infoString = toLowerCase(pSearchInfo.getValue().trim()); HashSet changeTypes = new HashSet(); boolean changesOnly = true; boolean returnECs = true; StringTokenizer tokenizer = new StringTokenizer(infoString, ":"); if (! tokenizer.hasMoreTokens()) { int msgID = MSGID_PSEARCH_MISSING_DESCRIPTOR; String message = getMessage(msgID); err.println(wrapText(message, MAX_LINE_WIDTH)); return 1; } else { String token = tokenizer.nextToken(); if (! token.equals("ps")) { int msgID = MSGID_PSEARCH_DOESNT_START_WITH_PS; String message = getMessage(msgID, String.valueOf(infoString)); err.println(wrapText(message, MAX_LINE_WIDTH)); return 1; } } if (tokenizer.hasMoreTokens()) { StringTokenizer st = new StringTokenizer(tokenizer.nextToken(), ", "); while (st.hasMoreTokens()) { String token = st.nextToken(); if (token.equals("add")) { changeTypes.add(PersistentSearchChangeType.ADD); } else if (token.equals("delete") || token.equals("del")) { changeTypes.add(PersistentSearchChangeType.DELETE); } else if (token.equals("modify") || token.equals("mod")) { changeTypes.add(PersistentSearchChangeType.MODIFY); } else if (token.equals("modifydn") || token.equals("moddn") || token.equals("modrdn")) { changeTypes.add(PersistentSearchChangeType.MODIFY_DN); } else if (token.equals("any") || token.equals("all")) { changeTypes.add(PersistentSearchChangeType.ADD); changeTypes.add(PersistentSearchChangeType.DELETE); changeTypes.add(PersistentSearchChangeType.MODIFY); changeTypes.add(PersistentSearchChangeType.MODIFY_DN); } else { int msgID = MSGID_PSEARCH_INVALID_CHANGE_TYPE; String message = getMessage(msgID, String.valueOf(token)); err.println(wrapText(message, MAX_LINE_WIDTH)); return 1; } } } if (changeTypes.isEmpty()) { changeTypes.add(PersistentSearchChangeType.ADD); changeTypes.add(PersistentSearchChangeType.DELETE); changeTypes.add(PersistentSearchChangeType.MODIFY); changeTypes.add(PersistentSearchChangeType.MODIFY_DN); } if (tokenizer.hasMoreTokens()) { String token = tokenizer.nextToken(); if (token.equals("1") || token.equals("true") || token.equals("yes")) { changesOnly = true; } else if (token.equals("0") || token.equals("false") || token.equals("no")) { changesOnly = false; } else { int msgID = MSGID_PSEARCH_INVALID_CHANGESONLY; String message = getMessage(msgID, String.valueOf(token)); err.println(wrapText(message, MAX_LINE_WIDTH)); return 1; } } if (tokenizer.hasMoreTokens()) { String token = tokenizer.nextToken(); if (token.equals("1") || token.equals("true") || token.equals("yes")) { returnECs = true; } else if (token.equals("0") || token.equals("false") || token.equals("no")) { returnECs = false; } else { int msgID = MSGID_PSEARCH_INVALID_RETURN_ECS; String message = getMessage(msgID, String.valueOf(token)); err.println(wrapText(message, MAX_LINE_WIDTH)); return 1; } } PersistentSearchControl psearchControl = new PersistentSearchControl(changeTypes, changesOnly, returnECs); searchOptions.getControls().add(new LDAPControl(psearchControl)); } if (assertionFilter.isPresent()) { String filterString = assertionFilter.getValue(); LDAPFilter filter; try { filter = LDAPFilter.decode(filterString); // FIXME -- Change this to the correct OID when the official one is // assigned. LDAPControl assertionControl = new LDAPControl(OID_LDAP_ASSERTION, true, new ASN1OctetString(filter.encode().encode())); searchOptions.getControls().add(assertionControl); } catch (LDAPException le) { int msgID = MSGID_LDAP_ASSERTION_INVALID_FILTER; String message = getMessage(msgID, le.getMessage()); err.println(wrapText(message, MAX_LINE_WIDTH)); return 1; } } if (matchedValuesFilter.isPresent()) { LinkedList mvFilterStrings = matchedValuesFilter.getValues(); ArrayList mvFilters = new ArrayList(); for (String s : mvFilterStrings) { try { LDAPFilter f = LDAPFilter.decode(s); mvFilters.add(MatchedValuesFilter.createFromLDAPFilter(f)); } catch (LDAPException le) { int msgID = MSGID_LDAP_MATCHEDVALUES_INVALID_FILTER; String message = getMessage(msgID, le.getMessage()); err.println(wrapText(message, MAX_LINE_WIDTH)); return 1; } } MatchedValuesControl mvc = new MatchedValuesControl(true, mvFilters); searchOptions.getControls().add(new LDAPControl(mvc)); } // Set the connection options. connectionOptions.setSASLExternal(saslExternal.isPresent()); if(saslOptions.isPresent()) { LinkedList values = saslOptions.getValues(); for(String saslOption : values) { if(saslOption.startsWith("mech=")) { boolean mechValue = connectionOptions.setSASLMechanism(saslOption); if(mechValue == false) { return 1; } } else { boolean propValue = connectionOptions.addSASLProperty(saslOption); if(propValue == false) { return 1; } } } } connectionOptions.setUseSSL(useSSL.isPresent()); connectionOptions.setStartTLS(startTLS.isPresent()); if(connectionOptions.useSASLExternal()) { if(!connectionOptions.useSSL() && !connectionOptions.useStartTLS()) { int msgID = MSGID_TOOL_SASLEXTERNAL_NEEDS_SSL_OR_TLS; String message = getMessage(msgID); err.println(wrapText(message, MAX_LINE_WIDTH)); return 1; } if(keyStorePathValue == null) { int msgID = MSGID_TOOL_SASLEXTERNAL_NEEDS_KEYSTORE; String message = getMessage(msgID); err.println(wrapText(message, MAX_LINE_WIDTH)); return 1; } } // Read the filter strings. if(fileNameValue != null) { BufferedReader in = null; try { in = new BufferedReader(new FileReader(fileNameValue)); String line = null; while ((line = in.readLine()) != null) { if(line.trim().equals("")) { // ignore empty lines. continue; } LDAPFilter ldapFilter = LDAPFilter.decode(line); filters.add(ldapFilter); } } catch(Exception e) { if (debugEnabled()) { debugCaught(DebugLogLevel.ERROR, e); } err.println(wrapText(e.getMessage(), MAX_LINE_WIDTH)); return 1; } finally { if(in != null) { try { in.close(); } catch (IOException ioe) {} } } } if(filters.isEmpty()) { int msgid = MSGID_SEARCH_NO_FILTERS; err.println(wrapText(getMessage(msgid), MAX_LINE_WIDTH)); err.println(argParser.getUsage()); return 1; } int wrapColumn = 80; if (dontWrap.isPresent()) { wrapColumn = 0; } try { if (initializeServer) { // Bootstrap and initialize directory data structures. DirectoryServer.bootstrapClient(); } // 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); connection.connectToHost(bindDNValue, bindPasswordValue, nextMessageID); int matchingEntries = 0; if (simplePageSize.isPresent()) { if (filters.size() > 1) { int msgID = MSGID_PAGED_RESULTS_REQUIRES_SINGLE_FILTER; String message = getMessage(msgID); throw new LDAPException(CLIENT_SIDE_PARAM_ERROR, msgID, message); } int pageSize = simplePageSize.getIntValue(); ASN1OctetString cookieValue = new ASN1OctetString(); ArrayList origControls = searchOptions.getControls(); while (true) { ArrayList newControls = new ArrayList(origControls.size()+1); newControls.addAll(origControls); newControls.add(new LDAPControl( new PagedResultsControl(true, pageSize, cookieValue))); searchOptions.setControls(newControls); LDAPSearch ldapSearch = new LDAPSearch(nextMessageID, out, err); matchingEntries += ldapSearch.executeSearch(connection, baseDNValue, filters, attributes, searchOptions, wrapColumn); ArrayList responseControls = ldapSearch.getResponseControls(); boolean responseFound = false; for (LDAPControl c :responseControls) { if (c.getOID().equals(OID_PAGED_RESULTS_CONTROL)) { try { PagedResultsControl control = new PagedResultsControl(c.isCritical(), c.getValue()); responseFound = true; cookieValue = control.getCookie(); break; } catch (LDAPException le) { int msgID = MSGID_PAGED_RESULTS_CANNOT_DECODE; String message = getMessage(msgID, le.getMessage()); throw new LDAPException(CLIENT_SIDE_DECODING_ERROR, msgID, message, le); } } } if (! responseFound) { int msgID = MSGID_PAGED_RESULTS_RESPONSE_NOT_FOUND; String message = getMessage(msgID); throw new LDAPException(CLIENT_SIDE_CONTROL_NOT_FOUND, msgID, message); } else if (cookieValue.value().length == 0) { break; } } } else { LDAPSearch ldapSearch = new LDAPSearch(nextMessageID, out, err); matchingEntries = ldapSearch.executeSearch(connection, baseDNValue, filters, attributes, searchOptions, wrapColumn); } if (countEntries.isPresent()) { return matchingEntries; } else { return 0; } } catch(LDAPException le) { if (debugEnabled()) { debugCaught(DebugLogLevel.ERROR, le); } err.println(wrapText(le.getMessage(), MAX_LINE_WIDTH)); int code = le.getResultCode(); return code; } catch(LDAPConnectionException lce) { if (debugEnabled()) { debugCaught(DebugLogLevel.ERROR, lce); } err.println(wrapText(lce.getMessage(), MAX_LINE_WIDTH)); int code = lce.getErrorCode(); return code; } catch(Exception e) { if (debugEnabled()) { debugCaught(DebugLogLevel.ERROR, e); } err.println(wrapText(e.getMessage(), MAX_LINE_WIDTH)); return 1; } finally { if(connection != null) { connection.close(); } } } }