src/core/src/main/java/org/apache/jmeter/util/SecurityProviderLoader.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.jmeter.util;

import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.security.Provider;
import java.security.Security;
import java.util.Comparator;
import java.util.Objects;
import java.util.Properties;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class SecurityProviderLoader {
    private static final Logger log = LoggerFactory.getLogger(SecurityProviderLoader.class);
    private static final Pattern CONFIGURATION_REGEX = Pattern.compile("^(?<classname>[^:]+)(:(?<position>\\d+)(:(?<config>.+))?)?$");

    private SecurityProviderLoader() {
        throw new IllegalStateException("Utility class");
    }

    public static void addSecurityProvider(Properties properties) {
        properties.keySet().stream()
                .filter(key -> key.toString().matches("security\\.provider(\\.\\d+)?"))
                .sorted(Comparator.comparing(String::valueOf)).forEach(key -> addSecurityProvider(properties.get(key).toString()));
    }

    public static void addSecurityProvider(String securityProviderConfig) {
        Matcher matcher = CONFIGURATION_REGEX.matcher(securityProviderConfig);

        if (matcher.matches()) {
            final String classname = matcher.group("classname");
            final int position = Integer.parseInt(Objects.toString(matcher.group("position"), "0"));
            final String config = matcher.group("config");

            try {
                @SuppressWarnings("unchecked")
                Class<Provider> providerClass = (Class<Provider>) Class.forName(classname);

                Provider provider = null;

                if (config != null) {
                    provider = tryConstructorWithString(providerClass, config);
                }

                if (provider == null) {
                    provider = providerClass.getDeclaredConstructor().newInstance();
                }
                int installedPosition = Security.insertProviderAt(provider, position);

                log.info("Security Provider {} ({}) is installed at position {}", provider.getClass().getSimpleName(),
                        provider.getName(), Integer.valueOf(installedPosition));
            } catch (Exception exception) {
                String message = String.format("Security Provider '%s' could not be installed.", classname);
                log.error(message, exception);
                System.err.print(message);
                System.err.println(" - see the log for more information.");
            }
        }
    }

    private static Provider tryConstructorWithString(Class<Provider> providerClass, final String config)
            throws InstantiationException, IllegalAccessException, InvocationTargetException {
        try {
            Constructor<Provider> constructor = providerClass.getConstructor(String.class);
            return constructor.newInstance(config);
        } catch (NoSuchMethodException e) {
            log.warn(
                    "Security Provider {} has no constructor with a single String argument - try to use default constructor.",
                    providerClass);
        }
        return null;
    }
}