/*

 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

import sun.management.jmxremote.ConnectorBootstrap;

import java.io.File;

import java.io.FileInputStream;

import java.io.FilenameFilter;

import java.io.IOException;

import java.net.BindException;

import java.rmi.server.ExportException;

import java.util.Properties;

import java.util.Iterator;

import java.util.Set;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.Map;

import java.util.Enumeration;

import javax.management.remote.*;

import javax.management.*;

import sun.management.AgentConfigurationError;

/**

 * <p>This class implements unit test for RMI Bootstrap.

 * When called with no arguments main() looks in the directory indicated

 * by the "test.src" system property for files called management*ok.properties

 * or management*ko.properties. The *ok.properties files are assumed to be

 * valid Java M&M config files for which the bootstrap should succeed.

 * The *ko.properties files are assumed to be configurations for which the

 * bootstrap & connection test will fail.</p>

 *

 * <p>The rmi port number can be specified with the "rmi.port" system property.

 * If not, this test will use the first available port</p>

 *

 * <p>When called with some argument, the main() will interprete its args to

 * be Java M&M configuration file names. The filenames are expected to end

 * with ok.properties or ko.properties - and are interpreted as above.</p>

 *

 * <p>Note that a limitation of the RMI registry (bug 4267864) prevent

 * this test from succeeding if more than 1 configuration is used.

 * As long as 4267864 isn't fix, this test must be called as many times

 * as needed but with a single argument (no arguments, or several arguments

 * will fail).</p>

 *

 * <p>Debug traces are logged in "sun.management.test"</p>

 **/

public class RmiBootstrapTest {

    // the number of consecutive ports to test for availability

    private static int MAX_GET_FREE_PORT_TRIES = 10;

    static TestLogger log =

        new TestLogger("RmiBootstrapTest");

    /**

     * Default values for RMI configuration properties.

     **/

    public static interface DefaultValues {

        public static final String PORT="0";

        public static final String CONFIG_FILE_NAME="management.properties";

        public static final String USE_SSL="true";

        public static final String USE_AUTHENTICATION="true";

        public static final String PASSWORD_FILE_NAME="jmxremote.password";

        public static final String ACCESS_FILE_NAME="jmxremote.access";

        public static final String KEYSTORE="keystore";

        public static final String KEYSTORE_PASSWD="password";

        public static final String TRUSTSTORE="truststore";

        public static final String TRUSTSTORE_PASSWD="trustword";

        public static final String SSL_NEED_CLIENT_AUTH="false";

    }

    /**

     * Names of RMI configuration properties.

     **/

    public static interface PropertyNames {

        public static final String PORT=

            "com.sun.management.jmxremote.port";

        public static final String CONFIG_FILE_NAME=

            "com.sun.management.config.file";

        public static final String USE_SSL=

            "com.sun.management.jmxremote.ssl";

        public static final String USE_AUTHENTICATION=

            "com.sun.management.jmxremote.authenticate";

        public static final String PASSWORD_FILE_NAME=

            "com.sun.management.jmxremote.password.file";

        public static final String ACCESS_FILE_NAME=

            "com.sun.management.jmxremote.access.file";

        public static final String INSTRUMENT_ALL=

            "com.sun.management.instrumentall";

        public static final String CREDENTIALS =

            "jmx.remote.credentials";

        public static final String KEYSTORE=

            "javax.net.ssl.keyStore";

        public static final String KEYSTORE_PASSWD=

            "javax.net.ssl.keyStorePassword";

        public static final String TRUSTSTORE=

            "javax.net.ssl.trustStore";

        public static final String TRUSTSTORE_PASSWD=

            "javax.net.ssl.trustStorePassword";

        public static final String SSL_ENABLED_CIPHER_SUITES =

            "com.sun.management.jmxremote.ssl.enabled.cipher.suites";

        public static final String SSL_ENABLED_PROTOCOLS =

            "com.sun.management.jmxremote.ssl.enabled.protocols";

        public static final String SSL_NEED_CLIENT_AUTH =

            "com.sun.management.jmxremote.ssl.need.client.auth";

    }

    /**

     * A filter to find all filenames who match <prefix>*<suffix>.

     * Note that <prefix> and <suffix> can overlap.

     **/

    private static class ConfigFilenameFilter implements FilenameFilter {

        final String suffix;

        final String prefix;

        ConfigFilenameFilter(String prefix, String suffix) {

            this.suffix=suffix;

            this.prefix=prefix;

        }

        public boolean accept(File dir, String name) {

            return (name.startsWith(prefix) && name.endsWith(suffix));

        }

    }

    /**

     * Get all "management*ok.properties" files in the directory

     * indicated by the "test.src" management property.

     **/

    private static File[] findConfigurationFilesOk() {

        final String testSrc = System.getProperty("test.src");

        final File dir = new File(testSrc);

        final FilenameFilter filter =

            new ConfigFilenameFilter("management_test","ok.properties");

        return dir.listFiles(filter);

    }

    /**

     * Get all "management*ko.properties" files in the directory

     * indicated by the "test.src" management property.

     **/

    private static File[] findConfigurationFilesKo() {

        final String testSrc = System.getProperty("test.src");

        final File dir = new File(testSrc);

        final FilenameFilter filter =

            new ConfigFilenameFilter("management_test","ko.properties");

        return dir.listFiles(filter);

    }

    /**

     * List all MBeans and their attributes. Used to test communication

     * with the Java M&M MBean Server.

     * @return the number of queried MBeans.

     */

    public static int listMBeans(MBeanServerConnection server)

        throws IOException {

        return listMBeans(server,null,null);

    }

    /**

     * List all matching MBeans and their attributes.

     * Used to test communication with the Java M&M MBean Server.

     * @return the number of matching MBeans.

     */

    public static int listMBeans(MBeanServerConnection server,

                                  ObjectName pattern, QueryExp query)

        throws IOException {

        final Set names = server.queryNames(pattern,query);

        for (final Iterator i=names.iterator(); i.hasNext(); ) {

            ObjectName name = (ObjectName)i.next();

            log.trace("listMBeans","Got MBean: "+name);

            try {

                MBeanInfo info =

                    server.getMBeanInfo((ObjectName)name);

                MBeanAttributeInfo[] attrs = info.getAttributes();

                if (attrs == null) continue;

                for (int j=0; j<attrs.length; j++) {

                    if (attrs[j].isReadable()) {

                        try {

                            Object o =

                                server.getAttribute(name,attrs[j].getName());

                            if (log.isDebugOn())

                                log.debug("listMBeans","\t\t" +

                                          attrs[j].getName() +

                                          " = "+o);

                        } catch (Exception x) {

                            log.trace("listMBeans","JmxClient failed to get " +

                                      attrs[j].getName() + ": " + x);

                            final IOException io =

                                new IOException("JmxClient failed to get " +

                                                attrs[j].getName());

                            io.initCause(x);

                            throw io;

                        }

                    }

                }

            } catch (Exception x) {

               log.trace("listMBeans",

                         "JmxClient failed to get MBeanInfo: "  + x);

                final IOException io =

                    new IOException("JmxClient failed to get MBeanInfo: "+x);

                io.initCause(x);

                throw io;

            }

        }

        return names.size();

    }

    /**

     * Compute the full path name for a default file.

     * @param basename basename (with extension) of the default file.

     **/

    private static String getDefaultFileName(String basename) {

        final String fileSeparator = File.separator;

        final StringBuffer defaultFileName =

            new StringBuffer(System.getProperty("java.home")).

            append("management").append(fileSeparator).

            append(basename);

        return defaultFileName.toString();

    }

    /**

     * Compute the full path name for a default file.

     * @param basename basename (with extension) of the default file.

     **/

    private static String getDefaultStoreName(String basename) {

        final String fileSeparator = File.separator;

        final StringBuffer defaultFileName =

            new StringBuffer(System.getProperty("test.src")).

            append(fileSeparator).append("ssl").append(fileSeparator).

            append(basename);

        return defaultFileName.toString();

    }

    /**

     * Parses the password file to read the credentials.

     * Returns an ArrayList of arrays of 2 string:

     * {<subject>, <password>}.

     * If the password file does not exists, return an empty list.

     * (File not found = empty file).

     **/

    private ArrayList readCredentials(String passwordFileName)

        throws IOException {

        final Properties pws = new Properties();

        final ArrayList  result = new ArrayList();

        final File f = new File(passwordFileName);

        if (!f.exists()) return result;

        FileInputStream fin = new FileInputStream(passwordFileName);

        try {pws.load(fin);}finally{fin.close();}

        for (Enumeration en=pws.propertyNames();en.hasMoreElements();) {

            final String[] cred = new String[2];

            cred[0]=(String)en.nextElement();

            cred[1]=pws.getProperty(cred[0]);

            result.add(cred);

        }

        return result;

    }

    /**

     * Connect with the given url, using all given credentials in turn.

     * A null entry in the useCredentials arrays indicate a connection

     * where no credentials are used.

     * @param url JMXServiceURL of the server.

     * @param useCredentials An array of credentials (a credential

     *        is a two String array, so this is an array of arrays

     *        of strings:

     *           useCredentials[i][0]=subject

     *           useCredentials[i][1]=password

     *        if useCredentials[i] == null means no credentials.

     * @param expectConnectOk true if connection is expected to succeed

     *    Note: if expectConnectOk=false and the test fails to connect

     *          the number of failure is not incremented. Conversely,

     *          if expectConnectOk=false and the test does not fail to

     *          connect the number of failure is incremented.

     * @param expectReadOk true if communication (listMBeans) is expected

     *        to succeed.

     *    Note: if expectReadOk=false and the test fails to read MBeans

     *          the number of failure is not incremented. Conversely,

     *          if expectReadOk=false and the test does not fail to

     *          read MBeans the number of failure is incremented.

     * @return number of failure.

     **/

    public int connectAndRead(JMXServiceURL url,

                              Object[] useCredentials,

                              boolean  expectConnectOk,

                              boolean  expectReadOk)

        throws IOException {

        int errorCount = 0;

        for (int i=0 ; i<useCredentials.length ; i++) {

            final Map m = new HashMap();

            final String[] credentials = (String[])useCredentials[i];

            final String   crinfo;

            if (credentials != null) {

                crinfo = "{"+credentials[0] + ", " + credentials[1] + "}";

                m.put(PropertyNames.CREDENTIALS,credentials);

            } else {

                crinfo="no credentials";

            }

            log.trace("testCommunication","using credentials: " + crinfo);

            final JMXConnector c;

            try {

                c = JMXConnectorFactory.connect(url,m);

            } catch (IOException x ) {

                if (expectConnectOk) {

                    final String err = "Connection failed for " + crinfo +

                        ": " + x;

                    System.out.println(err);

                    log.trace("testCommunication",err);

                    log.debug("testCommunication",x);

                    errorCount++;

                    continue;

                } else {

                    System.out.println("Connection failed as expected for " +

                                       crinfo + ": " + x);

                    continue;

                }

            } catch (RuntimeException x ) {

                if (expectConnectOk) {

                    final String err = "Connection failed for " + crinfo +

                        ": " + x;

                    System.out.println(err);

                    log.trace("testCommunication",err);

                    log.debug("testCommunication",x);

                    errorCount++;

                    continue;

                } else {

                    System.out.println("Connection failed as expected for " +

                                       crinfo + ": " + x);

                    continue;

                }

            }

            try {

                MBeanServerConnection conn =

                    c.getMBeanServerConnection();

                if (log.isDebugOn()) {

                    log.debug("testCommunication","Connection is:" + conn);

                    log.debug("testCommunication","Server domain is: " +

                              conn.getDefaultDomain());

                }

                final ObjectName pattern =

                    new ObjectName("java.lang:type=Memory,*");

                final int count = listMBeans(conn,pattern,null);

                if (count == 0)

                    throw new Exception("Expected at least one matching "+

                                        "MBean for "+pattern);

                if (expectReadOk) {

                    System.out.println("Communication succeeded " +

                                       "as expected for "+

                                       crinfo + ": found " + count

                                       + ((count<2)?"MBean":"MBeans"));

                } else {

                    final String err = "Expected failure didn't occur for " +

                        crinfo;

                    System.out.println(err);

                    errorCount++;

                }

            } catch (IOException x ) {

                if (expectReadOk) {

                    final String err = "Communication failed with " + crinfo +

                        ": " + x;

                    System.out.println(err);

                    log.trace("testCommunication",err);

                    log.debug("testCommunication",x);

                    errorCount++;

                    continue;

                } else {

                    System.out.println("Communication failed as expected for "+

                                       crinfo + ": " + x);

                    continue;

                }

            } catch (RuntimeException x ) {

                if (expectReadOk) {

                    final String err = "Communication failed with " + crinfo +

                        ": " + x;

                    System.out.println(err);

                    log.trace("testCommunication",err);

                    log.debug("testCommunication",x);

                    errorCount++;

                    continue;

                } else {

                    System.out.println("Communication failed as expected for "+

                                       crinfo + ": " + x);

                }

            } catch (Exception x) {

                final String err = "Failed to read MBeans with " + crinfo +

                    ": " + x;

                System.out.println(err);

                log.trace("testCommunication",err);

                log.debug("testCommunication",x);

                errorCount++;

                continue;

            } finally {

                c.close();

            }

        }

        return errorCount;

    }

    private void setSslProperties() {

        final String defaultKeyStore =

            getDefaultStoreName(DefaultValues.KEYSTORE);

        final String defaultTrustStore =

            getDefaultStoreName(DefaultValues.TRUSTSTORE);

        final String keyStore =

            System.getProperty(PropertyNames.KEYSTORE, defaultKeyStore);

        System.setProperty(PropertyNames.KEYSTORE,keyStore);

        log.trace("setSslProperties",PropertyNames.KEYSTORE+"="+keyStore);

        final String password =

            System.getProperty(PropertyNames.KEYSTORE_PASSWD,

                               DefaultValues.KEYSTORE_PASSWD);

        System.setProperty(PropertyNames.KEYSTORE_PASSWD,password);

        log.trace("setSslProperties",

                  PropertyNames.KEYSTORE_PASSWD+"="+password);

        final String trustStore =

            System.getProperty(PropertyNames.TRUSTSTORE,

                               defaultTrustStore);

        System.setProperty(PropertyNames.TRUSTSTORE,trustStore);

        log.trace("setSslProperties",

                  PropertyNames.TRUSTSTORE+"="+trustStore);

        final String trustword =

            System.getProperty(PropertyNames.TRUSTSTORE_PASSWD,

                               DefaultValues.TRUSTSTORE_PASSWD);

        System.setProperty(PropertyNames.TRUSTSTORE_PASSWD,trustword);

        log.trace("setSslProperties",

                  PropertyNames.TRUSTSTORE_PASSWD+"="+trustword);

    }

    private void checkSslConfiguration() {

        try {

            final String defaultConf =

                getDefaultFileName(DefaultValues.CONFIG_FILE_NAME);

            final String confname =

                System.getProperty(PropertyNames.CONFIG_FILE_NAME,defaultConf);

            final Properties props = new Properties();

            final File conf = new File(confname);

            if (conf.exists()) {

                FileInputStream fin = new FileInputStream(conf);

                try {props.load(fin);} finally {fin.close();}

            }

            // Do we use SSL?

            final String  useSslStr =

                props.getProperty(PropertyNames.USE_SSL,

                                  DefaultValues.USE_SSL);

            final boolean useSsl =

                Boolean.valueOf(useSslStr).booleanValue();

            log.debug("checkSslConfiguration",

                      PropertyNames.USE_SSL+"="+useSsl+

                      ": setting SSL");

            // Do we use SSL client authentication?

            final String  useSslClientAuthStr =

                props.getProperty(PropertyNames.SSL_NEED_CLIENT_AUTH,

                                  DefaultValues.SSL_NEED_CLIENT_AUTH);

            final boolean useSslClientAuth =

                Boolean.valueOf(useSslClientAuthStr).booleanValue();

            log.debug("checkSslConfiguration",

                      PropertyNames.SSL_NEED_CLIENT_AUTH+"="+useSslClientAuth);

            // Do we use customized SSL cipher suites?

            final String sslCipherSuites =

                props.getProperty(PropertyNames.SSL_ENABLED_CIPHER_SUITES);

            log.debug("checkSslConfiguration",

                      PropertyNames.SSL_ENABLED_CIPHER_SUITES + "=" +

                      sslCipherSuites);

            // Do we use customized SSL protocols?

            final String sslProtocols =

                props.getProperty(PropertyNames.SSL_ENABLED_PROTOCOLS);

            log.debug("checkSslConfiguration",

                      PropertyNames.SSL_ENABLED_PROTOCOLS + "=" +

                      sslProtocols);

            if (useSsl) setSslProperties();

        } catch (Exception x) {

            System.out.println("Failed to setup SSL configuration: " + x);

            log.debug("checkSslConfiguration",x);

        }

    }

    /**

     * Tests the server bootstraped at the given URL.

     * Uses the system properties to determine which config file is used.

     * Loads the config file to determine which password file is used.

     * Loads the password file to find out wich credentials to use.

     * Also checks that unregistered user/passwords are not allowed to

     * connect when a password file is used.

     *

     * This method calls connectAndRead().

     **/

    public void testCommunication(JMXServiceURL url)