Skip to content

Commit

Permalink
Supporting Authentication Plugins and Kernel Isolation
Browse files Browse the repository at this point in the history
Use a Child-First ClassLoader to isolate plugins from the kernel, giving priority to plugin classes to prevent conflicts between the plugin and kernel classes.
Allow users to place plugins in a specified directory, such as auth-lib, to avoid classpath conflicts by default.
Support developers in debugging plugins by allowing them to bring in plugins via Maven, making the debugging process more convenient.
  • Loading branch information
CalvinKirs committed Sep 23, 2024
1 parent 1f33137 commit c1fc289
Show file tree
Hide file tree
Showing 3 changed files with 258 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
// 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.doris.common.util;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URISyntaxException;
import java.net.URL;
import java.net.URLClassLoader;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.List;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;

/**
* ChildFirstClassLoader is a custom class loader designed to load classes from
* plugin JAR files. It uses a child-first class loading strategy, where the loader
* first attempts to load classes from its own URLs (plugin JARs), and if the class
* is not found, it delegates the loading to its parent class loader.
* <p>
* This class is intended for plugin-based systems where classes defined in plugins
* might override or replace standard library classes.
* <p>
* Key features:
* - Child-First loading mechanism.
* - Support for loading classes from multiple JAR files.
* - Efficient caching of JAR file resources to avoid repeated file access.
*/
public class ChildFirstClassLoader extends URLClassLoader {

// A list of URLs pointing to JAR files
private final List<URL> jarURLs;

/**
* Constructs a new ChildFirstClassLoader with the given URLs and parent class loader.
* This constructor stores the URLs for class loading.
*
* @param urls The URLs pointing to the plugin JAR files.
* @param parent The parent class loader to use for delegation if class is not found.
* @throws IOException If there is an error opening the JAR files.
* @throws URISyntaxException If there is an error converting the URL to URI.
*/
public ChildFirstClassLoader(URL[] urls, ClassLoader parent) throws IOException, URISyntaxException {
super(urls, parent);
this.jarURLs = new ArrayList<>();
for (URL url : urls) {
if ("file".equals(url.getProtocol())) {
this.jarURLs.add(url);
}
}
}

/**
* Attempts to load the class with the specified name.
* This method first tries to find the class using the current class loader (child-first strategy),
* and if the class is not found, it delegates the loading to the parent class loader.
*
* @param name The fully qualified name of the class to be loaded.
* @param resolve If true, the class will be resolved after being loaded.
* @return The resulting Class object.
* @throws ClassNotFoundException If the class cannot be found by either the child or parent loader.
*/
@Override
protected Class<?> loadClass(String name, boolean resolve) throws ClassNotFoundException {
// Child-First mechanism: try to find the class locally first
try {
return findClass(name);
} catch (ClassNotFoundException e) {
// If the class is not found locally, delegate to the parent class loader
return super.loadClass(name, resolve);
}
}

/**
* Searches for the class in the loaded plugin JAR files.
* If the class is found in one of the JAR files, it will be defined and returned.
*
* @param name The fully qualified name of the class to find.
* @return The resulting Class object.
* @throws ClassNotFoundException If the class cannot be found in the JAR files.
*/
@Override
protected Class<?> findClass(String name) throws ClassNotFoundException {
String classFile = name.replace('.', '/') + ".class"; // Convert class name to path

// Iterate over all the JAR URLs to find the class
for (URL jarURL : jarURLs) {
try (JarFile jarFile = new JarFile(Paths.get(jarURL.toURI()).toFile())) {
JarEntry entry = jarFile.getJarEntry(classFile);
if (entry != null) {
try (InputStream inputStream = jarFile.getInputStream(entry)) {
byte[] classData = readAllBytes(inputStream);
// Define the class from the byte array
return defineClass(name, classData, 0, classData.length);
}
}
} catch (IOException | URISyntaxException e) {
// Log and continue to the next JAR file
e.printStackTrace(); // Replace with proper logging if needed
}
}
// If the class was not found in any JAR file, throw ClassNotFoundException
throw new ClassNotFoundException(name);
}

/**
* Reads all bytes from the given InputStream.
* This method reads the entire content of the InputStream and returns it as a byte array.
*
* @param inputStream The InputStream to read from.
* @return A byte array containing the data from the InputStream.
* @throws IOException If an I/O error occurs while reading the stream.
*/
private byte[] readAllBytes(InputStream inputStream) throws IOException {
try (ByteArrayOutputStream outputStream = new ByteArrayOutputStream()) {
byte[] buffer = new byte[1024];
int bytesRead;
while ((bytesRead = inputStream.read(buffer)) != -1) {
outputStream.write(buffer, 0, bytesRead);
}
return outputStream.toByteArray();
}
}

/**
* Closes all open JAR files and releases any resources held by this class loader.
* This method should be called when the class loader is no longer needed to avoid resource leaks.
*
* @throws IOException If an I/O error occurs while closing the JAR files.
*/
@Override
public void close() throws IOException {
super.close(); // Call the superclass close method
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
// 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.doris.common.util;

import org.apache.doris.common.EnvUtils;
import org.apache.doris.mysql.authenticate.AuthenticatorFactory;

import org.apache.commons.collections.map.HashedMap;

import java.io.File;
import java.io.IOException;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.ServiceLoader;

public class ClassLoaderUtils {

private static final Map<String, String> pluginDirMapping = new HashedMap();

static {
pluginDirMapping.put(AuthenticatorFactory.class.getSimpleName(), "auth-lib");
}

/**
* Loads service implementations from JAR files in the specified plugin directory.
*
* @param serviceClass The class type of the service to load.
* @param <T> The type of the service.
* @return A list of service instances loaded from JAR files.
* @throws IOException If there is an error reading the JAR files or directory.
* @throws RuntimeException If there is a problem with the directory mapping or URL creation.
*/
public static <T> List<T> loadServicesFromDirectory(Class<T> serviceClass) throws IOException {
String pluginDirKey = serviceClass.getSimpleName();
String pluginDir = pluginDirMapping.get(pluginDirKey);
if (pluginDir == null) {
throw new RuntimeException("No mapping found for plugin directory key: " + pluginDirKey);
}

String jarDirPath = EnvUtils.getDorisHome() + File.separator + pluginDir;
File jarDir = new File(jarDirPath);

if (!jarDir.isDirectory()) {
throw new IOException("The specified path is not a directory: " + jarDirPath);
}

File[] jarFiles = jarDir.listFiles((dir, name) -> name.endsWith(".jar"));
if (jarFiles == null || jarFiles.length == 0) {
throw new IOException("No JAR files found in the specified directory: " + jarDirPath);
}

List<T> services = new ArrayList<>();
for (File jarFile : jarFiles) {
URL[] jarURLs;
jarURLs = new URL[]{jarFile.toURI().toURL()};

try (ChildFirstClassLoader urlClassLoader = new ChildFirstClassLoader(jarURLs,
Thread.currentThread().getContextClassLoader())) {
ServiceLoader<T> serviceLoader = ServiceLoader.load(serviceClass, urlClassLoader);
for (T service : serviceLoader) {
services.add(service);
}
} catch (URISyntaxException e) {
throw new RuntimeException(e);
}
}
return services;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
package org.apache.doris.mysql.authenticate;

import org.apache.doris.common.EnvUtils;
import org.apache.doris.common.util.ClassLoaderUtils;
import org.apache.doris.mysql.MysqlAuthPacket;
import org.apache.doris.mysql.MysqlChannel;
import org.apache.doris.mysql.MysqlHandshakePacket;
Expand All @@ -33,6 +34,7 @@
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.List;
import java.util.Optional;
import java.util.Properties;
import java.util.ServiceLoader;
Expand Down Expand Up @@ -69,6 +71,23 @@ private Authenticator loadFactoriesByName(String identifier) throws Exception {
return factory.create(loadConfigFile());
}
}
return loadCustomerFactories(identifier);

}

private Authenticator loadCustomerFactories(String identifier) throws Exception {
List<AuthenticatorFactory> factories = ClassLoaderUtils.loadServicesFromDirectory(AuthenticatorFactory.class);
if (factories.isEmpty()) {
LOG.info("No customer authenticator found, using default authenticator");
return defaultAuthenticator;
}
for (AuthenticatorFactory factory : factories) {
LOG.info("Found Customer Authenticator Plugin Factory: {}", factory.factoryIdentifier());
if (factory.factoryIdentifier().equalsIgnoreCase(identifier)) {
return factory.create(loadConfigFile());
}
}

throw new RuntimeException("No AuthenticatorFactory found for identifier: " + identifier);
}

Expand Down

0 comments on commit c1fc289

Please sign in to comment.