ch.qos.logback.core.net.HardenedObjectInputStream Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
There is a newer version: 2024.11.18751.20241128T090041Z-241100
/**
 * Logback: the reliable, generic, fast and flexible logging framework.
 * Copyright (C) 1999-2023, QOS.ch. All rights reserved.
 *
 * This program and the accompanying materials are dual-licensed under
 * either the terms of the Eclipse Public License v1.0 as published by
 * the Eclipse Foundation
 *
 *   or (per the licensee's choosing)
 *
 * under the terms of the GNU Lesser General Public License version 2.1
 * as published by the Free Software Foundation.
 */
package ch.qos.logback.core.net;

import ch.qos.logback.core.util.EnvUtil;
import java.io.IOException;
import java.io.InputStream;
import java.io.InvalidClassException;
import java.io.ObjectInputStream;
import java.io.ObjectStreamClass;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;

/**
 *  HardenedObjectInputStream restricts the set of classes that can be deserialized to a set of
 *  explicitly whitelisted classes. This prevents certain type of attacks from being successful.
 *
 *  It is assumed that classes in the "java.lang" and  "java.util" packages are
 *  always authorized.
 *
 *  @author Ceki Gülcü
 *  @since 1.2.0
 *
 * @deprecated This internal logback API is not supported by AEM as a Cloud Service.
 */
@Deprecated(since = "2022-01-27")
public class HardenedObjectInputStream extends ObjectInputStream {

    final List whitelistedClassNames;

    final static String[] JAVA_PACKAGES = new String[] { "java.lang", "java.util" };

    final private static int DEPTH_LIMIT = 16;

    final private static int ARRAY_LIMIT = 10000;

    public HardenedObjectInputStream(InputStream in, String[] whilelist) throws IOException {
        super(in);
        initObjectFilter();
        this.whitelistedClassNames = new ArrayList();
        if (whilelist != null) {
            for (int i = 0; i < whilelist.length; i++) {
                this.whitelistedClassNames.add(whilelist[i]);
            }
        }
    }

    public HardenedObjectInputStream(InputStream in, List whitelist) throws IOException {
        super(in);
        initObjectFilter();
        this.whitelistedClassNames = new ArrayList();
        this.whitelistedClassNames.addAll(whitelist);
    }

    private void initObjectFilter() {
        // invoke the following code by reflection
        // this.setObjectInputFilter(ObjectInputFilter.Config.createFilter(
        // "maxarray=" + ARRAY_LIMIT + ";maxdepth=" + DEPTH_LIMIT + ";"
        // ));
        if (EnvUtil.isJDK9OrHigher()) {
            try {
                ClassLoader classLoader = this.getClass().getClassLoader();
                Class oifClass = classLoader.loadClass("java.io.ObjectInputFilter");
                Class oifConfigClass = classLoader.loadClass("java.io.ObjectInputFilter$Config");
                Method setObjectInputFilterMethod = this.getClass().getMethod("setObjectInputFilter", oifClass);
                Method createFilterMethod = oifConfigClass.getMethod("createFilter", String.class);
                Object filter = createFilterMethod.invoke(null, "maxarray=" + ARRAY_LIMIT + ";maxdepth=" + DEPTH_LIMIT + ";");
                setObjectInputFilterMethod.invoke(this, filter);
            } catch (ClassNotFoundException e) {
                // this code should be unreachable
                throw new RuntimeException("Failed to initialize object filter", e);
            } catch (InvocationTargetException e) {
                // this code should be unreachable
                throw new RuntimeException("Failed to initialize object filter", e);
            } catch (NoSuchMethodException e) {
                // this code should be unreachable
                throw new RuntimeException("Failed to initialize object filter", e);
            } catch (IllegalAccessException e) {
                // this code should be unreachable
                throw new RuntimeException("Failed to initialize object filter", e);
            }
        }
    }

    @Override
    protected Class resolveClass(ObjectStreamClass anObjectStreamClass) throws IOException, ClassNotFoundException {
        String incomingClassName = anObjectStreamClass.getName();
        if (!isWhitelisted(incomingClassName)) {
            throw new InvalidClassException("Unauthorized deserialization attempt", anObjectStreamClass.getName());
        }
        return super.resolveClass(anObjectStreamClass);
    }

    private boolean isWhitelisted(String incomingClassName) {
        for (int i = 0; i < JAVA_PACKAGES.length; i++) {
            if (incomingClassName.startsWith(JAVA_PACKAGES[i]))
                return true;
        }
        for (String whiteListed : whitelistedClassNames) {
            if (incomingClassName.equals(whiteListed))
                return true;
        }
        return false;
    }

    protected void addToWhitelist(List additionalAuthorizedClasses) {
        whitelistedClassNames.addAll(additionalAuthorizedClasses);
    }
}