Source code

001/**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.activemq.util;
018
019import java.io.IOException;
020import java.io.InputStream;
021import java.io.ObjectInputStream;
022import java.io.ObjectStreamClass;
023import java.lang.reflect.Proxy;
024import java.util.*;
025
026import org.slf4j.Logger;
027import org.slf4j.LoggerFactory;
028
029public class ClassLoadingAwareObjectInputStream extends ObjectInputStream {
030
031    private static final Logger LOG = LoggerFactory.getLogger(ClassLoadingAwareObjectInputStream.class);
032    private static final ClassLoader FALLBACK_CLASS_LOADER =
033        ClassLoadingAwareObjectInputStream.class.getClassLoader();
034
035    public static final String[] serializablePackages;
036
037    private List<String> trustedPackages = new ArrayList<String>();
038    private boolean trustAllPackages = false;
039
040    private final ClassLoader inLoader;
041
042    static {
043        serializablePackages = System.getProperty("org.apache.activemq.SERIALIZABLE_PACKAGES","org.apache.activemq,org.fusesource.hawtbuf,com.thoughtworks.xstream.mapper").split(",");
044    }
045
046    public ClassLoadingAwareObjectInputStream(InputStream in) throws IOException {
047        super(in);
048        inLoader = in.getClass().getClassLoader();
049        trustedPackages.addAll(Arrays.asList(serializablePackages));
050    }
051
052    @Override
053    protected Class<?> resolveClass(ObjectStreamClass classDesc) throws IOException, ClassNotFoundException {
054        ClassLoader cl = Thread.currentThread().getContextClassLoader();
055        Class clazz = load(classDesc.getName(), cl, inLoader);
056        checkSecurity(clazz);
057        return clazz;
058    }
059
060    @Override
061    protected Class<?> resolveProxyClass(String[] interfaces) throws IOException, ClassNotFoundException {
062        ClassLoader cl = Thread.currentThread().getContextClassLoader();
063        Class[] cinterfaces = new Class[interfaces.length];
064        for (int i = 0; i < interfaces.length; i++) {
065            cinterfaces[i] = load(interfaces[i], cl);
066        }
067
068        Class clazz = null;
069        try {
070            clazz = Proxy.getProxyClass(cl, cinterfaces);
071        } catch (IllegalArgumentException e) {
072            try {
073                clazz = Proxy.getProxyClass(inLoader, cinterfaces);
074            } catch (IllegalArgumentException e1) {
075                // ignore
076            }
077            try {
078                clazz = Proxy.getProxyClass(FALLBACK_CLASS_LOADER, cinterfaces);
079            } catch (IllegalArgumentException e2) {
080                // ignore
081            }
082        }
083
084        if (clazz != null) {
085            checkSecurity(clazz);
086            return clazz;
087        } else {
088            throw new ClassNotFoundException(null);
089        }
090    }
091
092    public static boolean isAllAllowed() {
093        return serializablePackages.length == 1 && serializablePackages[0].equals("*");
094    }
095
096    private boolean trustAllPackages() {
097        return trustAllPackages || (trustedPackages.size() == 1 && trustedPackages.get(0).equals("*"));
098    }
099
100    private void checkSecurity(Class clazz) throws ClassNotFoundException {
101        if (!clazz.isPrimitive()) {
102            if (clazz.getPackage() != null && !trustAllPackages()) {
103               boolean found = false;
104               for (String packageName : getTrustedPackages()) {
105                   if (clazz.getPackage().getName().equals(packageName) || clazz.getPackage().getName().startsWith(packageName + ".")) {
106                       found = true;
107                       break;
108                   }
109               }
110               if (!found) {
111                   throw new ClassNotFoundException("Forbidden " + clazz + "! This class is not trusted to be serialized as ObjectMessage payload. Please take a look at http://activemq.apache.org/objectmessage.html for more information on how to configure trusted classes.");
112               }
113            }
114        }
115    }
116
117    private Class<?> load(String className, ClassLoader... cl) throws ClassNotFoundException {
118        // check for simple types first
119        final Class<?> clazz = loadSimpleType(className);
120        if (clazz != null) {
121            LOG.trace("Loaded class: {} as simple type -> {}", className, clazz);
122            return clazz;
123        }
124
125        // try the different class loaders
126        for (ClassLoader loader : cl) {
127            LOG.trace("Attempting to load class: {} using classloader: {}", className, cl);
128            try {
129                Class<?> answer = Class.forName(className, false, loader);
130                if (LOG.isTraceEnabled()) {
131                    LOG.trace("Loaded class: {} using classloader: {} -> {}", className, cl, answer);
132                }
133                return answer;
134            } catch (ClassNotFoundException e) {
135                LOG.trace("Class not found: {} using classloader: {}", className, cl);
136                // ignore
137            }
138        }
139
140        // and then the fallback class loader
141        return Class.forName(className, false, FALLBACK_CLASS_LOADER);
142    }
143
144    /**
145     * Load a simple type
146     *
147     * @param name the name of the class to load
148     * @return the class or <tt>null</tt> if it could not be loaded
149     */
150    public static Class<?> loadSimpleType(String name) {
151        // code from ObjectHelper.loadSimpleType in Apache Camel
152
153        // special for byte[] or Object[] as its common to use
154        if ("java.lang.byte[]".equals(name) || "byte[]".equals(name)) {
155            return byte[].class;
156        } else if ("java.lang.Byte[]".equals(name) || "Byte[]".equals(name)) {
157            return Byte[].class;
158        } else if ("java.lang.Object[]".equals(name) || "Object[]".equals(name)) {
159            return Object[].class;
160        } else if ("java.lang.String[]".equals(name) || "String[]".equals(name)) {
161            return String[].class;
162            // and these is common as well
163        } else if ("java.lang.String".equals(name) || "String".equals(name)) {
164            return String.class;
165        } else if ("java.lang.Boolean".equals(name) || "Boolean".equals(name)) {
166            return Boolean.class;
167        } else if ("boolean".equals(name)) {
168            return boolean.class;
169        } else if ("java.lang.Integer".equals(name) || "Integer".equals(name)) {
170            return Integer.class;
171        } else if ("int".equals(name)) {
172            return int.class;
173        } else if ("java.lang.Long".equals(name) || "Long".equals(name)) {
174            return Long.class;
175        } else if ("long".equals(name)) {
176            return long.class;
177        } else if ("java.lang.Short".equals(name) || "Short".equals(name)) {
178            return Short.class;
179        } else if ("short".equals(name)) {
180            return short.class;
181        } else if ("java.lang.Byte".equals(name) || "Byte".equals(name)) {
182            return Byte.class;
183        } else if ("byte".equals(name)) {
184            return byte.class;
185        } else if ("java.lang.Float".equals(name) || "Float".equals(name)) {
186            return Float.class;
187        } else if ("float".equals(name)) {
188            return float.class;
189        } else if ("java.lang.Double".equals(name) || "Double".equals(name)) {
190            return Double.class;
191        } else if ("double".equals(name)) {
192            return double.class;
193        } else if ("void".equals(name)) {
194            return void.class;
195        }
196
197        return null;
198    }
199
200    public List<String> getTrustedPackages() {
201        return trustedPackages;
202    }
203
204    public void setTrustedPackages(List<String> trustedPackages) {
205        this.trustedPackages = trustedPackages;
206    }
207
208    public void addTrustedPackage(String trustedPackage) {
209        this.trustedPackages.add(trustedPackage);
210    }
211
212    public boolean isTrustAllPackages() {
213        return trustAllPackages;
214    }
215
216    public void setTrustAllPackages(boolean trustAllPackages) {
217        this.trustAllPackages = trustAllPackages;
218    }
219}