1 /* 2 * Copyright (c) 2008, 2018, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package sun.invoke.util; 27 28 import java.lang.reflect.Modifier; 29 import static java.lang.reflect.Modifier.*; 30 import java.util.Objects; 31 import jdk.internal.reflect.Reflection; 32 33 /** 34 * This class centralizes information about the JVM's linkage access control. 35 * @author jrose 36 */ 37 public class VerifyAccess { 38 39 private VerifyAccess() { } // cannot instantiate 40 41 private static final int UNCONDITIONAL_ALLOWED = java.lang.invoke.MethodHandles.Lookup.UNCONDITIONAL; 42 private static final int MODULE_ALLOWED = java.lang.invoke.MethodHandles.Lookup.MODULE; 43 private static final int PACKAGE_ONLY = 0; 44 private static final int PACKAGE_ALLOWED = java.lang.invoke.MethodHandles.Lookup.PACKAGE; 45 private static final int PROTECTED_OR_PACKAGE_ALLOWED = (PACKAGE_ALLOWED|PROTECTED); 46 private static final int ALL_ACCESS_MODES = (PUBLIC|PRIVATE|PROTECTED|PACKAGE_ONLY); 47 48 /** 49 * Evaluate the JVM linkage rules for access to the given method 50 * on behalf of a caller class which proposes to perform the access. 51 * Return true if the caller class has privileges to invoke a method 52 * or access a field with the given properties. 53 * This requires an accessibility check of the referencing class, 54 * plus an accessibility check of the member within the class, 55 * which depends on the member's modifier flags. 56 * <p> 57 * The relevant properties include the defining class ({@code defc}) 58 * of the member, and its modifier flags ({@code mods}). 59 * Also relevant is the class used to make the initial symbolic reference 60 * to the member ({@code refc}). If this latter class is not distinguished, 61 * the defining class should be passed for both arguments ({@code defc == refc}). 62 * <h3>JVM Specification, 5.4.4 "Access Control"</h3> 63 * A field or method R is accessible to a class or interface D if 64 * and only if any of the following is true: 65 * <ul> 66 * <li>R is public.</li> 67 * <li>R is protected and is declared in a class C, and D is either 68 * a subclass of C or C itself. Furthermore, if R is not static, 69 * then the symbolic reference to R must contain a symbolic 70 * reference to a class T, such that T is either a subclass of D, 71 * a superclass of D, or D itself. 72 * <p>During verification, it was also required that, even if T is 73 * a superclass of D, the target reference of a protected instance 74 * field access or method invocation must be an instance of D or a 75 * subclass of D (4.10.1.8).</p></li> 76 * <li>R is either protected or has default access (that is, neither 77 * public nor protected nor private), and is declared by a class 78 * in the same run-time package as D.</li> 79 * <li>R is private and is declared in D by a class or interface 80 * belonging to the same nest as D.</li> 81 * </ul> 82 * If a referenced field or method is not accessible, access checking 83 * throws an IllegalAccessError. If an exception is thrown while 84 * attempting to determine the nest host of a class or interface, 85 * access checking fails for the same reason. 86 * 87 * @param refc the class used in the symbolic reference to the proposed member 88 * @param defc the class in which the proposed member is actually defined 89 * @param mods modifier flags for the proposed member 90 * @param lookupClass the class for which the access check is being made 91 * @return true iff the accessing class can access such a member 92 */ 93 public static boolean isMemberAccessible(Class<?> refc, // symbolic ref class 94 Class<?> defc, // actual def class 95 int mods, // actual member mods 96 Class<?> lookupClass, 97 int allowedModes) { 98 if (allowedModes == 0) return false; 99 assert((allowedModes & PUBLIC) != 0 && 100 (allowedModes & ~(ALL_ACCESS_MODES|PACKAGE_ALLOWED|MODULE_ALLOWED|UNCONDITIONAL_ALLOWED)) == 0); 101 // The symbolic reference class (refc) must always be fully verified. 102 if (!isClassAccessible(refc, lookupClass, allowedModes)) { 103 return false; 104 } 105 // Usually refc and defc are the same, but verify defc also in case they differ. 106 if (defc == lookupClass && 107 (allowedModes & PRIVATE) != 0) 108 return true; // easy check; all self-access is OK with a private lookup 109 110 switch (mods & ALL_ACCESS_MODES) { 111 case PUBLIC: 112 return true; // already checked above 113 case PROTECTED: 114 assert !defc.isInterface(); // protected members aren't allowed in interfaces 115 if ((allowedModes & PROTECTED_OR_PACKAGE_ALLOWED) != 0 && 116 isSamePackage(defc, lookupClass)) 117 return true; 118 if ((allowedModes & PROTECTED) == 0) 119 return false; 120 // Protected members are accessible by subclasses, which does not include interfaces. 121 // Interfaces are types, not classes. They should not have access to 122 // protected members in j.l.Object, even though it is their superclass. 123 if ((mods & STATIC) != 0 && 124 !isRelatedClass(refc, lookupClass)) 125 return false; 126 if ((allowedModes & PROTECTED) != 0 && 127 isSubClass(lookupClass, defc)) 128 return true; 129 return false; 130 case PACKAGE_ONLY: // That is, zero. Unmarked member is package-only access. 131 assert !defc.isInterface(); // package-private members aren't allowed in interfaces 132 return ((allowedModes & PACKAGE_ALLOWED) != 0 && 133 isSamePackage(defc, lookupClass)); 134 case PRIVATE: 135 // Rules for privates follows access rules for nestmates. 136 boolean canAccess = ((allowedModes & PRIVATE) != 0 && 137 Reflection.areNestMates(defc, lookupClass)); 138 // FIX ME: Sanity check refc == defc. Either remove or convert to 139 // plain assert before integration. 140 myassert((canAccess && refc == defc) || !canAccess); 141 return canAccess; 142 default: 143 throw new IllegalArgumentException("bad modifiers: "+Modifier.toString(mods)); 144 } 145 } 146 static void myassert(boolean cond) { 147 if (!cond) throw new Error("Assertion failed"); 148 } 149 150 static boolean isRelatedClass(Class<?> refc, Class<?> lookupClass) { 151 return (refc == lookupClass || 152 isSubClass(refc, lookupClass) || 153 isSubClass(lookupClass, refc)); 154 } 155 156 static boolean isSubClass(Class<?> lookupClass, Class<?> defc) { 157 return defc.isAssignableFrom(lookupClass) && 158 !lookupClass.isInterface(); // interfaces are types, not classes. 159 } 160 161 static int getClassModifiers(Class<?> c) { 162 // This would return the mask stored by javac for the source-level modifiers. 163 // return c.getModifiers(); 164 // But what we need for JVM access checks are the actual bits from the class header. 165 // ...But arrays and primitives are synthesized with their own odd flags: 166 if (c.isArray() || c.isPrimitive()) 167 return c.getModifiers(); 168 return Reflection.getClassAccessFlags(c); 169 } 170 171 /** 172 * Evaluate the JVM linkage rules for access to the given class on behalf of caller. 173 * <h3>JVM Specification, 5.4.4 "Access Control"</h3> 174 * A class or interface C is accessible to a class or interface D 175 * if and only if any of the following conditions are true:<ul> 176 * <li>C is public and in the same module as D. 177 * <li>D is in a module that reads the module containing C, C is public and in a 178 * package that is exported to the module that contains D. 179 * <li>C and D are members of the same runtime package. 180 * </ul> 181 * @param refc the symbolic reference class to which access is being checked (C) 182 * @param lookupClass the class performing the lookup (D) 183 */ 184 public static boolean isClassAccessible(Class<?> refc, Class<?> lookupClass, 185 int allowedModes) { 186 if (allowedModes == 0) return false; 187 assert((allowedModes & PUBLIC) != 0 && 188 (allowedModes & ~(ALL_ACCESS_MODES|PACKAGE_ALLOWED|MODULE_ALLOWED|UNCONDITIONAL_ALLOWED)) == 0); 189 int mods = getClassModifiers(refc); 190 if (isPublic(mods)) { 191 192 Module lookupModule = lookupClass.getModule(); 193 Module refModule = refc.getModule(); 194 195 // early VM startup case, java.base not defined 196 if (lookupModule == null) { 197 assert refModule == null; 198 return true; 199 } 200 201 // trivially allow 202 if ((allowedModes & MODULE_ALLOWED) != 0 && 203 (lookupModule == refModule)) 204 return true; 205 206 // check readability when UNCONDITIONAL not allowed 207 if (((allowedModes & UNCONDITIONAL_ALLOWED) != 0) 208 || lookupModule.canRead(refModule)) { 209 210 // check that refc is in an exported package 211 if ((allowedModes & MODULE_ALLOWED) != 0) { 212 if (refModule.isExported(refc.getPackageName(), lookupModule)) 213 return true; 214 } else { 215 // exported unconditionally 216 if (refModule.isExported(refc.getPackageName())) 217 return true; 218 } 219 220 // not exported but allow access during VM initialization 221 // because java.base does not have its exports setup 222 if (!jdk.internal.misc.VM.isModuleSystemInited()) 223 return true; 224 } 225 226 // public class not accessible to lookupClass 227 return false; 228 } 229 if ((allowedModes & PACKAGE_ALLOWED) != 0 && 230 isSamePackage(lookupClass, refc)) 231 return true; 232 return false; 233 } 234 235 /** 236 * Decide if the given method type, attributed to a member or symbolic 237 * reference of a given reference class, is really visible to that class. 238 * @param type the supposed type of a member or symbolic reference of refc 239 * @param refc the class attempting to make the reference 240 */ 241 public static boolean isTypeVisible(Class<?> type, Class<?> refc) { 242 if (type == refc) { 243 return true; // easy check 244 } 245 while (type.isArray()) type = type.getComponentType(); 246 if (type.isPrimitive() || type == Object.class) { 247 return true; 248 } 249 ClassLoader typeLoader = type.getClassLoader(); 250 ClassLoader refcLoader = refc.getClassLoader(); 251 if (typeLoader == refcLoader) { 252 return true; 253 } 254 if (refcLoader == null && typeLoader != null) { 255 return false; 256 } 257 if (typeLoader == null && type.getName().startsWith("java.")) { 258 // Note: The API for actually loading classes, ClassLoader.defineClass, 259 // guarantees that classes with names beginning "java." cannot be aliased, 260 // because class loaders cannot load them directly. 261 return true; 262 } 263 264 // Do it the hard way: Look up the type name from the refc loader. 265 // 266 // Force the refc loader to report and commit to a particular binding for this type name (type.getName()). 267 // 268 // In principle, this query might force the loader to load some unrelated class, 269 // which would cause this query to fail (and the original caller to give up). 270 // This would be wasted effort, but it is expected to be very rare, occurring 271 // only when an attacker is attempting to create a type alias. 272 // In the normal case, one class loader will simply delegate to the other, 273 // and the same type will be visible through both, with no extra loading. 274 // 275 // It is important to go through Class.forName instead of ClassLoader.loadClass 276 // because Class.forName goes through the JVM system dictionary, which records 277 // the class lookup once for all. This means that even if a not-well-behaved class loader 278 // would "change its mind" about the meaning of the name, the Class.forName request 279 // will use the result cached in the JVM system dictionary. Note that the JVM system dictionary 280 // will record the first successful result. Unsuccessful results are not stored. 281 // 282 // We use doPrivileged in order to allow an unprivileged caller to ask an arbitrary 283 // class loader about the binding of the proposed name (type.getName()). 284 // The looked up type ("res") is compared for equality against the proposed 285 // type ("type") and then is discarded. Thus, the worst that can happen to 286 // the "child" class loader is that it is bothered to load and report a class 287 // that differs from "type"; this happens once due to JVM system dictionary 288 // memoization. And the caller never gets to look at the alternate type binding 289 // ("res"), whether it exists or not. 290 final String name = type.getName(); 291 Class<?> res = java.security.AccessController.doPrivileged( 292 new java.security.PrivilegedAction<>() { 293 public Class<?> run() { 294 try { 295 return Class.forName(name, false, refcLoader); 296 } catch (ClassNotFoundException | LinkageError e) { 297 return null; // Assume the class is not found 298 } 299 } 300 }); 301 return (type == res); 302 } 303 304 /** 305 * Decide if the given method type, attributed to a member or symbolic 306 * reference of a given reference class, is really visible to that class. 307 * @param type the supposed type of a member or symbolic reference of refc 308 * @param refc the class attempting to make the reference 309 */ 310 public static boolean isTypeVisible(java.lang.invoke.MethodType type, Class<?> refc) { 311 if (!isTypeVisible(type.returnType(), refc)) { 312 return false; 313 } 314 for (int n = 0, max = type.parameterCount(); n < max; n++) { 315 if (!isTypeVisible(type.parameterType(n), refc)) { 316 return false; 317 } 318 } 319 return true; 320 } 321 322 /** 323 * Tests if two classes are in the same module. 324 * @param class1 a class 325 * @param class2 another class 326 * @return whether they are in the same module 327 */ 328 public static boolean isSameModule(Class<?> class1, Class<?> class2) { 329 return class1.getModule() == class2.getModule(); 330 } 331 332 /** 333 * Test if two classes have the same class loader and package qualifier. 334 * @param class1 a class 335 * @param class2 another class 336 * @return whether they are in the same package 337 */ 338 public static boolean isSamePackage(Class<?> class1, Class<?> class2) { 339 assert(!class1.isArray() && !class2.isArray()); 340 if (class1 == class2) 341 return true; 342 if (class1.getClassLoader() != class2.getClassLoader()) 343 return false; 344 return Objects.equals(class1.getPackageName(), class2.getPackageName()); 345 } 346 347 /** 348 * Test if two classes are defined as part of the same package member (top-level class). 349 * If this is true, they can share private access with each other. 350 * @param class1 a class 351 * @param class2 another class 352 * @return whether they are identical or nested together 353 */ 354 public static boolean isSamePackageMember(Class<?> class1, Class<?> class2) { 355 if (class1 == class2) 356 return true; 357 if (!isSamePackage(class1, class2)) 358 return false; 359 if (getOutermostEnclosingClass(class1) != getOutermostEnclosingClass(class2)) 360 return false; 361 return true; 362 } 363 364 private static Class<?> getOutermostEnclosingClass(Class<?> c) { 365 Class<?> pkgmem = c; 366 for (Class<?> enc = c; (enc = enc.getEnclosingClass()) != null; ) 367 pkgmem = enc; 368 return pkgmem; 369 } 370 371 private static boolean loadersAreRelated(ClassLoader loader1, ClassLoader loader2, 372 boolean loader1MustBeParent) { 373 if (loader1 == loader2 || loader1 == null 374 || (loader2 == null && !loader1MustBeParent)) { 375 return true; 376 } 377 for (ClassLoader scan2 = loader2; 378 scan2 != null; scan2 = scan2.getParent()) { 379 if (scan2 == loader1) return true; 380 } 381 if (loader1MustBeParent) return false; 382 // see if loader2 is a parent of loader1: 383 for (ClassLoader scan1 = loader1; 384 scan1 != null; scan1 = scan1.getParent()) { 385 if (scan1 == loader2) return true; 386 } 387 return false; 388 } 389 390 /** 391 * Is the class loader of parentClass identical to, or an ancestor of, 392 * the class loader of childClass? 393 * @param parentClass a class 394 * @param childClass another class, which may be a descendent of the first class 395 * @return whether parentClass precedes or equals childClass in class loader order 396 */ 397 public static boolean classLoaderIsAncestor(Class<?> parentClass, Class<?> childClass) { 398 return loadersAreRelated(parentClass.getClassLoader(), childClass.getClassLoader(), true); 399 } 400 }