1 /* 2 * Copyright (c) 1999, 2013, 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 java.lang.reflect; 27 28 import java.lang.ref.WeakReference; 29 import java.security.AccessController; 30 import java.security.PrivilegedAction; 31 import java.util.Arrays; 32 import java.util.Collections; 33 import java.util.Deque; 34 import java.util.HashMap; 35 import java.util.HashSet; 36 import java.util.IdentityHashMap; 37 import java.util.LinkedList; 38 import java.util.List; 39 import java.util.Map; 40 import java.util.Objects; 41 import java.util.Set; 42 import java.util.WeakHashMap; 43 import java.util.concurrent.atomic.AtomicInteger; 44 import java.util.concurrent.atomic.AtomicLong; 45 import java.util.function.BiFunction; 46 import java.util.stream.Collectors; 47 import java.util.stream.Stream; 48 49 import jdk.internal.loader.BootLoader; 50 import jdk.internal.module.Modules; 51 import jdk.internal.misc.Unsafe; 52 import jdk.internal.misc.VM; 53 import sun.reflect.CallerSensitive; 54 import sun.reflect.Reflection; 55 import sun.reflect.misc.ReflectUtil; 56 import sun.security.util.SecurityConstants; 57 58 /** 59 * 60 * {@code Proxy} provides static methods for creating objects that act like instances 61 * of interfaces but allow for customized method invocation. 62 * To create a proxy instance for some interface {@code Foo}: 63 * <pre>{@code 64 * InvocationHandler handler = new MyInvocationHandler(...); 65 * Foo f = (Foo) Proxy.newProxyInstance(Foo.class.getClassLoader(), 66 * new Class<?>[] { Foo.class }, 67 * handler); 68 * }</pre> 69 * 70 * <p> 71 * A <em>proxy class</em> is a class created at runtime that implements a specified 72 * list of interfaces, known as <em>proxy interfaces</em>. A <em>proxy instance</em> 73 * is an instance of a proxy class. 74 * 75 * Each proxy instance has an associated <i>invocation handler</i> 76 * object, which implements the interface {@link InvocationHandler}. 77 * A method invocation on a proxy instance through one of its proxy 78 * interfaces will be dispatched to the {@link InvocationHandler#invoke 79 * invoke} method of the instance's invocation handler, passing the proxy 80 * instance, a {@code java.lang.reflect.Method} object identifying 81 * the method that was invoked, and an array of type {@code Object} 82 * containing the arguments. The invocation handler processes the 83 * encoded method invocation as appropriate and the result that it 84 * returns will be returned as the result of the method invocation on 85 * the proxy instance. 86 * 87 * <p>A proxy class has the following properties: 88 * 89 * <ul> 90 * <li>The unqualified name of a proxy class is unspecified. The space 91 * of class names that begin with the string {@code "$Proxy"} 92 * should be, however, reserved for proxy classes. 93 * 94 * <li>The package and module in which a proxy class is defined is specified 95 * <a href="#membership">below</a>. 96 * 97 * <li>A proxy class is <em>final and non-abstract</em>. 98 * 99 * <li>A proxy class extends {@code java.lang.reflect.Proxy}. 100 * 101 * <li>A proxy class implements exactly the interfaces specified at its 102 * creation, in the same order. Invoking {@link Class#getInterfaces getInterfaces} 103 * on its {@code Class} object will return an array containing the same 104 * list of interfaces (in the order specified at its creation), invoking 105 * {@link Class#getMethods getMethods} on its {@code Class} object will return 106 * an array of {@code Method} objects that include all of the 107 * methods in those interfaces, and invoking {@code getMethod} will 108 * find methods in the proxy interfaces as would be expected. 109 * 110 * <li>The {@link java.security.ProtectionDomain} of a proxy class 111 * is the same as that of system classes loaded by the bootstrap class 112 * loader, such as {@code java.lang.Object}, because the code for a 113 * proxy class is generated by trusted system code. This protection 114 * domain will typically be granted {@code java.security.AllPermission}. 115 * 116 * <li>The {@link Proxy#isProxyClass Proxy.isProxyClass} method can be used 117 * to determine if a given class is a proxy class. 118 * </ul> 119 * 120 * <p>A proxy instance has the following properties: 121 * 122 * <ul> 123 * <li>Given a proxy instance {@code proxy} and one of the 124 * interfaces, {@code Foo}, implemented by its proxy class, the 125 * following expression will return true: 126 * <pre> 127 * {@code proxy instanceof Foo} 128 * </pre> 129 * and the following cast operation will succeed (rather than throwing 130 * a {@code ClassCastException}): 131 * <pre> 132 * {@code (Foo) proxy} 133 * </pre> 134 * 135 * <li>Each proxy instance has an associated invocation handler, the one 136 * that was passed to its constructor. The static 137 * {@link Proxy#getInvocationHandler Proxy.getInvocationHandler} method 138 * will return the invocation handler associated with the proxy instance 139 * passed as its argument. 140 * 141 * <li>An interface method invocation on a proxy instance will be 142 * encoded and dispatched to the invocation handler's {@link 143 * InvocationHandler#invoke invoke} method as described in the 144 * documentation for that method. 145 * 146 * <li>An invocation of the {@code hashCode}, 147 * {@code equals}, or {@code toString} methods declared in 148 * {@code java.lang.Object} on a proxy instance will be encoded and 149 * dispatched to the invocation handler's {@code invoke} method in 150 * the same manner as interface method invocations are encoded and 151 * dispatched, as described above. The declaring class of the 152 * {@code Method} object passed to {@code invoke} will be 153 * {@code java.lang.Object}. Other public methods of a proxy 154 * instance inherited from {@code java.lang.Object} are not 155 * overridden by a proxy class, so invocations of those methods behave 156 * like they do for instances of {@code java.lang.Object}. 157 * </ul> 158 * 159 * <h3><a name="membership">Package and Module Membership of Proxy Class</a></h3> 160 * 161 * The package and module to which a proxy class belongs are chosen such that 162 * the accessibility of the proxy class is in line with the accessibility of 163 * the proxy interfaces. Specifically, the package and the module membership 164 * of a proxy class defined via the 165 * {@link Proxy#getProxyClass(ClassLoader, Class[])} or 166 * {@link Proxy#newProxyInstance(ClassLoader, Class[], InvocationHandler)} 167 * methods is specified as follows: 168 * 169 * <ol> 170 * <li>If all the proxy interfaces are in <em>exported</em> packages: 171 * <ol type="a"> 172 * <li>if all the proxy interfaces are <em>public</em>, then the proxy class is 173 * <em>public</em> in a package exported by the 174 * {@linkplain ClassLoader#getUnnamedModule() unnamed module} of the specified 175 * loader. The name of the package is unspecified.</li> 176 * 177 * <li>if at least one of all the proxy interfaces is <em>non-public</em>, then 178 * the proxy class is <em>non-public</em> in the package and module of the 179 * non-public interfaces. All the non-public interfaces must be in the same 180 * package and module; otherwise, proxying them is 181 * <a href="#restrictions">not possible</a>.</li> 182 * </ol> 183 * </li> 184 * <li>If at least one proxy interface is a <em>non-exported</em> package: 185 * <ol type="a"> 186 * <li>if all the proxy interfaces are <em>public</em>, then the proxy class is 187 * <em>public</em> in a <em>non-exported</em> package of 188 * <a href="#dynamicmodule"><em>dynamic module</em>.</a> 189 * The names of the package and the module are unspecified.</li> 190 * 191 * <li>if at least one of all the proxy interfaces is <em>non-public</em>, then 192 * the proxy class is <em>non-public</em> in the package and module of the 193 * non-public interfaces. All the non-public interfaces must be in the same 194 * package and module; otherwise, proxying them is 195 * <a href="#restrictions">not possible</a>.</li> 196 * </ol> 197 * </li> 198 * </ol> 199 * 200 * <p> 201 * Note that if proxy interfaces with a mix of accessibilities -- 202 * exported public, exported non-public, non-exported public, non-exported non-public -- 203 * are proxied by the same instance, then the proxy class's accessibility is 204 * governed by the least accessible proxy interface. 205 * <p> 206 * Note that it is possible for arbitrary code to obtain access to a proxy class 207 * in an exported package with {@link AccessibleObject#setAccessible setAccessible}, 208 * whereas a proxy class in a non-exported package is never accessible to 209 * code outside the module of the proxy class. 210 * 211 * <p> 212 * Throughout this specification, a "non-exported package" refers to a package that 213 * is not exported to all modules. Specifically, it refers to a package that 214 * either is not exported at all by its containing module or is exported in a 215 * qualified fashion by its containing module. 216 * 217 * <h3><a name="dynamicmodule">Dynamic Modules</a></h3> 218 * <p> 219 * A dynamic module is a named module generated at runtime. A proxy class 220 * defined in a dynamic module is encapsulated and not accessible to any module. 221 * Calling {@link Constructor#newInstance(Object...)} on a proxy class in 222 * a dynamic module will throw {@code IllegalAccessException}; 223 * {@code Proxy.newProxyInstance} method should be used instead. 224 * 225 * <p> 226 * A dynamic module can read the modules of all of the superinterfaces of a proxy class 227 * and the modules of the types referenced by all public method signatures 228 * of a proxy class. If a superinterface or a referenced type, say {@code T}, 229 * is in a non-exported package, the {@linkplain java.lang.reflect.Module module} 230 * of {@code T} is updated to export the package of {@code T} to the dynamic module. 231 * 232 * <h3>Methods Duplicated in Multiple Proxy Interfaces</h3> 233 * 234 * <p>When two or more proxy interfaces contain a method with 235 * the same name and parameter signature, the order of the proxy class's 236 * interfaces becomes significant. When such a <i>duplicate method</i> 237 * is invoked on a proxy instance, the {@code Method} object passed 238 * to the invocation handler will not necessarily be the one whose 239 * declaring class is assignable from the reference type of the interface 240 * that the proxy's method was invoked through. This limitation exists 241 * because the corresponding method implementation in the generated proxy 242 * class cannot determine which interface it was invoked through. 243 * Therefore, when a duplicate method is invoked on a proxy instance, 244 * the {@code Method} object for the method in the foremost interface 245 * that contains the method (either directly or inherited through a 246 * superinterface) in the proxy class's list of interfaces is passed to 247 * the invocation handler's {@code invoke} method, regardless of the 248 * reference type through which the method invocation occurred. 249 * 250 * <p>If a proxy interface contains a method with the same name and 251 * parameter signature as the {@code hashCode}, {@code equals}, 252 * or {@code toString} methods of {@code java.lang.Object}, 253 * when such a method is invoked on a proxy instance, the 254 * {@code Method} object passed to the invocation handler will have 255 * {@code java.lang.Object} as its declaring class. In other words, 256 * the public, non-final methods of {@code java.lang.Object} 257 * logically precede all of the proxy interfaces for the determination of 258 * which {@code Method} object to pass to the invocation handler. 259 * 260 * <p>Note also that when a duplicate method is dispatched to an 261 * invocation handler, the {@code invoke} method may only throw 262 * checked exception types that are assignable to one of the exception 263 * types in the {@code throws} clause of the method in <i>all</i> of 264 * the proxy interfaces that it can be invoked through. If the 265 * {@code invoke} method throws a checked exception that is not 266 * assignable to any of the exception types declared by the method in one 267 * of the proxy interfaces that it can be invoked through, then an 268 * unchecked {@code UndeclaredThrowableException} will be thrown by 269 * the invocation on the proxy instance. This restriction means that not 270 * all of the exception types returned by invoking 271 * {@code getExceptionTypes} on the {@code Method} object 272 * passed to the {@code invoke} method can necessarily be thrown 273 * successfully by the {@code invoke} method. 274 * 275 * @author Peter Jones 276 * @see InvocationHandler 277 * @since 1.3 278 */ 279 public class Proxy implements java.io.Serializable { 280 private static final long serialVersionUID = -2222568056686623797L; 281 282 /** parameter types of a proxy class constructor */ 283 private static final Class<?>[] constructorParams = 284 { InvocationHandler.class }; 285 286 /** 287 * the invocation handler for this proxy instance. 288 * @serial 289 */ 290 protected InvocationHandler h; 291 292 /** 293 * Prohibits instantiation. 294 */ 295 private Proxy() { 296 } 297 298 /** 299 * Constructs a new {@code Proxy} instance from a subclass 300 * (typically, a dynamic proxy class) with the specified value 301 * for its invocation handler. 302 * 303 * @param h the invocation handler for this proxy instance 304 * 305 * @throws NullPointerException if the given invocation handler, {@code h}, 306 * is {@code null}. 307 */ 308 protected Proxy(InvocationHandler h) { 309 Objects.requireNonNull(h); 310 this.h = h; 311 } 312 313 /** 314 * Returns the {@code java.lang.Class} object for a proxy class 315 * given a class loader and an array of interfaces. The proxy class 316 * will be defined by the specified class loader and will implement 317 * all of the supplied interfaces. If any of the given interfaces 318 * is non-public, the proxy class will be non-public. If a proxy class 319 * for the same permutation of interfaces has already been defined by the 320 * class loader, then the existing proxy class will be returned; otherwise, 321 * a proxy class for those interfaces will be generated dynamically 322 * and defined by the class loader. 323 * 324 * @param loader the class loader to define the proxy class 325 * @param interfaces the list of interfaces for the proxy class 326 * to implement 327 * @return a proxy class that is defined in the specified class loader 328 * and that implements the specified interfaces 329 * @throws IllegalArgumentException if any of the <a href="#restrictions"> 330 * restrictions</a> on the parameters are violated 331 * @throws SecurityException if a security manager, <em>s</em>, is present 332 * and any of the following conditions is met: 333 * <ul> 334 * <li> the given {@code loader} is {@code null} and 335 * the caller's class loader is not {@code null} and the 336 * invocation of {@link SecurityManager#checkPermission 337 * s.checkPermission} with 338 * {@code RuntimePermission("getClassLoader")} permission 339 * denies access.</li> 340 * <li> for each proxy interface, {@code intf}, 341 * the caller's class loader is not the same as or an 342 * ancestor of the class loader for {@code intf} and 343 * invocation of {@link SecurityManager#checkPackageAccess 344 * s.checkPackageAccess()} denies access to {@code intf}.</li> 345 * </ul> 346 * @throws NullPointerException if the {@code interfaces} array 347 * argument or any of its elements are {@code null} 348 * 349 * @deprecated Proxy classes generated in a named module are encapsulated and not 350 * accessible to code outside its module. 351 * {@link Constructor#newInstance(Object...) Constructor.newInstance} will throw 352 * {@code IllegalAccessException} when it is called on an inaccessible proxy class. 353 * Use {@link #newProxyInstance(ClassLoader, Class[], InvocationHandler)} 354 * to create a proxy instance instead. 355 * 356 * @see <a href="#membership">Package and Module Membership of Proxy Class</a> 357 */ 358 @Deprecated 359 @CallerSensitive 360 public static Class<?> getProxyClass(ClassLoader loader, 361 Class<?>... interfaces) 362 throws IllegalArgumentException 363 { 364 final List<Class<?>> intfs = List.of(interfaces); // interfaces cloned 365 final SecurityManager sm = System.getSecurityManager(); 366 final Class<?> caller = Reflection.getCallerClass(); 367 if (sm != null) { 368 checkProxyAccess(caller, loader, intfs); 369 } 370 371 return new ProxyBuilder(loader, intfs).build(); 372 } 373 374 /* 375 * Check permissions required to create a Proxy class. 376 * 377 * To define a proxy class, it performs the access checks as in 378 * Class.forName (VM will invoke ClassLoader.checkPackageAccess): 379 * 1. "getClassLoader" permission check if loader == null 380 * 2. checkPackageAccess on the interfaces it implements 381 * 382 * To get a constructor and new instance of a proxy class, it performs 383 * the package access check on the interfaces it implements 384 * as in Class.getConstructor. 385 * 386 * If an interface is non-public, the proxy class must be defined by 387 * the defining loader of the interface. If the caller's class loader 388 * is not the same as the defining loader of the interface, the VM 389 * will throw IllegalAccessError when the generated proxy class is 390 * being defined. 391 */ 392 private static void checkProxyAccess(Class<?> caller, 393 ClassLoader loader, 394 List<Class<?>> interfaces) 395 { 396 SecurityManager sm = System.getSecurityManager(); 397 if (sm != null) { 398 ClassLoader ccl = caller.getClassLoader(); 399 if (VM.isSystemDomainLoader(loader) && !VM.isSystemDomainLoader(ccl)) { 400 sm.checkPermission(SecurityConstants.GET_CLASSLOADER_PERMISSION); 401 } 402 ReflectUtil.checkProxyPackageAccess(ccl, interfaces.toArray(EMPTY_CLASS_ARRAY)); 403 } 404 } 405 406 /* 407 * a key used for proxy class with 0 implemented interfaces 408 */ 409 private static final Object key0 = new Object(); 410 411 /* 412 * Key1 and Key2 are optimized for the common use of dynamic proxies 413 * that implement 1 or 2 interfaces. 414 */ 415 416 /* 417 * a key used for proxy class with 1 implemented interface 418 */ 419 private static final class Key1 extends WeakReference<Class<?>> { 420 private final int hash; 421 422 Key1(Class<?> intf) { 423 super(intf); 424 this.hash = intf.hashCode(); 425 } 426 427 @Override 428 public int hashCode() { 429 return hash; 430 } 431 432 @Override 433 public boolean equals(Object obj) { 434 Class<?> intf; 435 return this == obj || 436 obj != null && 437 obj.getClass() == Key1.class && 438 (intf = get()) != null && 439 intf == ((Key1) obj).get(); 440 } 441 } 442 443 /* 444 * a key used for proxy class with 2 implemented interfaces 445 */ 446 private static final class Key2 extends WeakReference<Class<?>> { 447 private final int hash; 448 private final WeakReference<Class<?>> ref2; 449 450 Key2(Class<?> intf1, Class<?> intf2) { 451 super(intf1); 452 hash = 31 * intf1.hashCode() + intf2.hashCode(); 453 ref2 = new WeakReference<>(intf2); 454 } 455 456 @Override 457 public int hashCode() { 458 return hash; 459 } 460 461 @Override 462 public boolean equals(Object obj) { 463 Class<?> intf1, intf2; 464 return this == obj || 465 obj != null && 466 obj.getClass() == Key2.class && 467 (intf1 = get()) != null && 468 intf1 == ((Key2) obj).get() && 469 (intf2 = ref2.get()) != null && 470 intf2 == ((Key2) obj).ref2.get(); 471 } 472 } 473 474 /* 475 * a key used for proxy class with any number of implemented interfaces 476 * (used here for 3 or more only) 477 */ 478 private static final class KeyX { 479 private final int hash; 480 private final WeakReference<Class<?>>[] refs; 481 482 @SuppressWarnings("unchecked") 483 KeyX(List<Class<?>> interfaces) { 484 hash = Arrays.hashCode(interfaces.toArray()); 485 refs = (WeakReference<Class<?>>[])new WeakReference<?>[interfaces.size()]; 486 int i = 0; 487 for (Class<?> intf : interfaces) { 488 refs[i++] = new WeakReference<>(intf); 489 } 490 } 491 492 @Override 493 public int hashCode() { 494 return hash; 495 } 496 497 @Override 498 public boolean equals(Object obj) { 499 return this == obj || 500 obj != null && 501 obj.getClass() == KeyX.class && 502 equals(refs, ((KeyX) obj).refs); 503 } 504 505 private static boolean equals(WeakReference<Class<?>>[] refs1, 506 WeakReference<Class<?>>[] refs2) { 507 if (refs1.length != refs2.length) { 508 return false; 509 } 510 for (int i = 0; i < refs1.length; i++) { 511 Class<?> intf = refs1[i].get(); 512 if (intf == null || intf != refs2[i].get()) { 513 return false; 514 } 515 } 516 return true; 517 } 518 } 519 520 /** 521 * A function that maps an array of interfaces to an optimal key where 522 * Class objects representing interfaces are weakly referenced. 523 */ 524 private static final class KeyFactory<T> 525 implements BiFunction<T, List<Class<?>>, Object> 526 { 527 @Override 528 public Object apply(T t, List<Class<?>> interfaces) { 529 switch (interfaces.size()) { 530 case 1: return new Key1(interfaces.get(0)); // the most frequent 531 case 2: return new Key2(interfaces.get(0), interfaces.get(1)); 532 case 0: return key0; 533 default: return new KeyX(interfaces); 534 } 535 } 536 } 537 538 /** 539 * A factory function that generates, defines and returns the proxy class 540 * given the ClassLoader and array of interfaces. 541 */ 542 private static final class ProxyClassFactory { 543 private static final Unsafe UNSAFE = Unsafe.getUnsafe(); 544 545 // prefix for all proxy class names 546 private static final String proxyClassNamePrefix = "$Proxy"; 547 548 // next number to use for generation of unique proxy class names 549 private static final AtomicLong nextUniqueNumber = new AtomicLong(); 550 551 private static Class<?> defineProxyClass(Module m, List<Class<?>> interfaces) { 552 String proxyPkg = null; // package to define proxy class in 553 int accessFlags = Modifier.PUBLIC | Modifier.FINAL; 554 555 /* 556 * Record the package of a non-public proxy interface so that the 557 * proxy class will be defined in the same package. Verify that 558 * all non-public proxy interfaces are in the same package. 559 */ 560 for (Class<?> intf : interfaces) { 561 int flags = intf.getModifiers(); 562 if (!Modifier.isPublic(flags)) { 563 accessFlags = Modifier.FINAL; // non-public, final 564 String pkg = intf.getPackageName(); 565 if (proxyPkg == null) { 566 proxyPkg = pkg; 567 } else if (!pkg.equals(proxyPkg)) { 568 throw new IllegalArgumentException( 569 "non-public interfaces from different packages"); 570 } 571 } 572 } 573 574 if (proxyPkg == null) { 575 // all proxy interfaces are public 576 proxyPkg = m.isNamed() ? PROXY_PACKAGE_PREFIX + "." + m.getName() 577 : PROXY_PACKAGE_PREFIX; 578 } else if (proxyPkg.isEmpty() && m.isNamed()) { 579 throw new IllegalArgumentException( 580 "Unnamed package cannot be added to " + m); 581 } 582 583 // add the package to the runtime module if not exists 584 if (m.isNamed()) { 585 m.addPackage(proxyPkg); 586 } 587 588 /* 589 * Choose a name for the proxy class to generate. 590 */ 591 long num = nextUniqueNumber.getAndIncrement(); 592 String proxyName = proxyPkg.isEmpty() ? proxyClassNamePrefix + num 593 : proxyPkg + "." + proxyClassNamePrefix + num; 594 595 ClassLoader loader = getLoader(m); 596 trace(proxyName, m, loader, interfaces); 597 598 /* 599 * Generate the specified proxy class. 600 */ 601 byte[] proxyClassFile = ProxyGenerator.generateProxyClass( 602 proxyName, interfaces.toArray(EMPTY_CLASS_ARRAY), accessFlags); 603 try { 604 return UNSAFE.defineClass(proxyName, proxyClassFile, 0, proxyClassFile.length, 605 loader, null); 606 } catch (ClassFormatError e) { 607 /* 608 * A ClassFormatError here means that (barring bugs in the 609 * proxy class generation code) there was some other 610 * invalid aspect of the arguments supplied to the proxy 611 * class creation (such as virtual machine limitations 612 * exceeded). 613 */ 614 throw new IllegalArgumentException(e.toString()); 615 } 616 } 617 618 /** 619 * Test if the given class is a proxy class 620 */ 621 static boolean isProxyClass(Class<?> c) { 622 return proxyCache.containsValue(c); 623 } 624 625 /** 626 * Returns the proxy class. It will return the cached proxy class 627 * if exists; otherwise, it will create the proxy class and store in 628 * the cache. 629 */ 630 static Class<?> get(Module module, List<Class<?>> interfaces) { 631 return proxyCache.get(module, interfaces); 632 } 633 634 /** 635 * a cache of proxy classes in the named and unnamed module 636 */ 637 private static final WeakCache<Module, List<Class<?>>, Class<?>> proxyCache = 638 new WeakCache<>(new KeyFactory<Module>(), 639 new BiFunction<Module, List<Class<?>>, Class<?>>() { 640 @Override 641 public Class<?> apply(Module m, List<Class<?>> interfaces) { 642 Objects.requireNonNull(m); 643 return defineProxyClass(m, interfaces); 644 } 645 }); 646 647 648 private static boolean isExportedType(Class<?> c) { 649 String pn = c.getPackageName(); 650 return Modifier.isPublic(c.getModifiers()) && c.getModule().isExported(pn); 651 } 652 653 private static boolean isPackagePrivateType(Class<?> c) { 654 return !Modifier.isPublic(c.getModifiers()); 655 } 656 657 private static String toDetails(Class<?> c) { 658 String access = "unknown"; 659 if (isExportedType(c)) { 660 access = "exported"; 661 } else if (isPackagePrivateType(c)) { 662 access = "package-private"; 663 } else { 664 access = "module-private"; 665 } 666 ClassLoader ld = c.getClassLoader(); 667 return String.format(" %s/%s %s loader %s", 668 c.getModule().getName(), c.getName(), access, ld); 669 } 670 671 static void trace(String cn, Module module, ClassLoader loader, List<Class<?>> interfaces) { 672 if (isDebug()) { 673 System.out.format("PROXY: %s/%s defined by %s%n", module.getName(), cn, loader); 674 } 675 if (isDebug("debug")) { 676 interfaces.stream() 677 .forEach(c -> System.out.println(toDetails(c))); 678 } 679 } 680 681 private static final String DEBUG = 682 AccessController.doPrivileged(new PrivilegedAction<>() { 683 public String run() { 684 return System.getProperty("jdk.proxy.debug", ""); 685 } 686 }); 687 688 private static final boolean isDebug() { 689 return !DEBUG.isEmpty(); 690 } 691 private static final boolean isDebug(String flag) { 692 return DEBUG.equals(flag); 693 } 694 } 695 696 /** 697 * Builder for a proxy class. 698 * 699 * If the module is not specified in this ProxyBuilder constructor, 700 * it will map from the given loader and interfaces to the module 701 * in which the proxy class will be defined. 702 */ 703 private static final class ProxyBuilder { 704 final ClassLoader loader; 705 final List<Class<?>> interfaces; 706 final Module module; 707 ProxyBuilder(ClassLoader loader, List<Class<?>> interfaces) { 708 if (!VM.isModuleSystemInited()) { 709 throw new InternalError("Proxy is not supported until module system is fully initialzed"); 710 } 711 if (interfaces.size() > 65535) { 712 throw new IllegalArgumentException("interface limit exceeded"); 713 } 714 715 Set<Class<?>> refTypes = referencedTypes(loader, interfaces); 716 717 // IAE if violates any restrictions specified in newProxyInstance 718 validateProxyInterfaces(loader, interfaces, refTypes); 719 720 this.loader = loader; 721 this.interfaces = interfaces; 722 this.module = mapToModule(loader, interfaces, refTypes); 723 assert getLoader(module) == loader; 724 } 725 726 /** 727 * Generate a proxy class. If the target module does not have any 728 * to any interface types, IllegalAccessError will be thrown by the VM 729 * at defineClass time. 730 * 731 * Must call the checkProxyAccess method to perform permission checks 732 * before calling this. 733 */ 734 Class<?> build() { 735 return ProxyClassFactory.get(module, interfaces); 736 } 737 738 /** 739 * Validate the given proxy interfaces and the given referenced types 740 * are visible to the defining loader. 741 * 742 * @throws IllegalArgumentException if it violates the restrictions specified 743 * in {@link Proxy#newProxyInstance} 744 */ 745 static void validateProxyInterfaces(ClassLoader loader, 746 List<Class<?>> interfaces, 747 Set<Class<?>> refTypes) 748 { 749 Map<Class<?>, Boolean> interfaceSet = new IdentityHashMap<>(interfaces.size()); 750 for (Class<?> intf : interfaces) { 751 /* 752 * Verify that the class loader resolves the name of this 753 * interface to the same Class object. 754 */ 755 ensureVisible(loader, intf); 756 757 /* 758 * Verify that the Class object actually represents an 759 * interface. 760 */ 761 if (!intf.isInterface()) { 762 throw new IllegalArgumentException(intf.getName() + " is not an interface"); 763 } 764 765 /* 766 * Verify that this interface is not a duplicate. 767 */ 768 if (interfaceSet.put(intf, Boolean.TRUE) != null) { 769 throw new IllegalArgumentException("repeated interface: " + intf.getName()); 770 } 771 } 772 773 for (Class<?> type : refTypes) { 774 ensureVisible(loader, type); 775 } 776 } 777 778 /* 779 * Returns all types referenced by all public method signatures of 780 * the proxy interfaces 781 */ 782 static Set<Class<?>> referencedTypes(ClassLoader loader, List<Class<?>> interfaces) { 783 return interfaces.stream() 784 .flatMap(intf -> Stream.of(intf.getMethods()) 785 .flatMap(m -> methodRefTypes(m)) 786 .map(ProxyBuilder::getElementType) 787 .filter(t -> !t.isPrimitive())) 788 .collect(Collectors.toSet()); 789 } 790 791 /* 792 * Extracts all types referenced on a method signature including 793 * its return type, parameter types, and exception types. 794 */ 795 static Stream<Class<?>> methodRefTypes(Method m) { 796 return Stream.of(new Class<?>[] { m.getReturnType() }, 797 m.getParameterTypes(), 798 m.getExceptionTypes()) 799 .flatMap(a -> Stream.of(a)); 800 } 801 802 /** 803 * Returns the module that the generated proxy class belongs to. 804 * 805 * If all proxy interfaces are public and in exported packages, 806 * then the proxy class is in unnamed module. 807 * 808 * If any of proxy interface is package-private, then the proxy class 809 * is in the same module of the package-private interface. 810 * 811 * If all proxy interfaces are public and at least one in a non-exported 812 * package, then the proxy class is in a dynamic module in a non-exported 813 * package. Reads edge and qualified exports are added for 814 * dynamic module to access. 815 */ 816 static Module mapToModule(ClassLoader loader, List<Class<?>> interfaces, Set<Class<?>> refTypes) { 817 Map<Class<?>, Module> modulePrivateTypes = new HashMap<>(); 818 Map<Class<?>, Module> packagePrivateTypes = new HashMap<>(); 819 for (Class<?> intf : interfaces) { 820 Module m = intf.getModule(); 821 if (Modifier.isPublic(intf.getModifiers())) { 822 // module-private types 823 if (!m.isExported(intf.getPackageName())) { 824 modulePrivateTypes.put(intf, m); 825 } 826 } else { 827 packagePrivateTypes.put(intf, m); 828 } 829 } 830 831 // all proxy interfaces are public and exported, the proxy class is in unnamed module 832 // Such proxy class is accessible to any unnamed module and named module that 833 // can read unnamed module 834 if (packagePrivateTypes.isEmpty() && modulePrivateTypes.isEmpty()) { 835 return loader != null ? loader.getUnnamedModule() : BootLoader.getUnnamedModule(); 836 } 837 838 if (packagePrivateTypes.size() > 0) { 839 // all package-private types must be in the same runtime package 840 // i.e. same package name and same module (named or unnamed) 841 // 842 // Configuration will fail if M1 and in M2 defined by the same loader 843 // and both have the same package p (so no need to check class loader) 844 if (packagePrivateTypes.size() > 1 && 845 (packagePrivateTypes.keySet().stream() // more than one package 846 .map(Class::getPackageName).distinct().count() > 1 || 847 packagePrivateTypes.values().stream() // or more than one module 848 .distinct().count() > 1)) { 849 throw new IllegalArgumentException( 850 "non-public interfaces from different packages"); 851 } 852 853 // all package-private types are in the same module (named or unnamed) 854 Module target = null; 855 for (Module m : packagePrivateTypes.values()) { 856 if (getLoader(m) != loader) { 857 // the specified loader is not the same class loader of the non-public interface 858 throw new IllegalArgumentException( 859 "non-public interface is not defined by the given loader"); 860 } 861 target = m; 862 } 863 864 // validate if the target module can access all other interfaces 865 for (Class<?> intf : interfaces) { 866 Module m = intf.getModule(); 867 if (m == target) continue; 868 869 if (!target.canRead(m) || !m.isExported(intf.getPackageName(), target)) { 870 throw new IllegalArgumentException(target + " can't access " + intf.getName()); 871 } 872 } 873 874 // return the module of the package-private interface 875 return target; 876 } 877 878 // all proxy interfaces are public and at least one in a non-exported package 879 // map to dynamic proxy module and add reads edge and qualified exports, if necessary 880 Module target = getDynamicModule(loader); 881 882 // set up proxy class access to proxy interfaces and superinterfaces 883 Deque<Class<?>> deque = new LinkedList<>(interfaces); 884 Set<Class<?>> visited = new HashSet<>(); 885 while (!deque.isEmpty()) { 886 Class<?> c = deque.poll(); 887 if (visited.contains(c)) { 888 continue; 889 } 890 visited.add(c); 891 ensureAccess(target, c); 892 893 // add all superinterfaces 894 for (Class<?> intf : c.getInterfaces()) { 895 deque.add(intf); 896 } 897 } 898 899 // set up proxy class access to types referenced in the method signature 900 refTypes.stream() 901 .filter(t -> !visited.contains(t)) 902 .forEach(t -> ensureAccess(target, t)); 903 return target; 904 } 905 906 /* 907 * Ensure the given module can access the given class. 908 */ 909 static void ensureAccess(Module target, Class<?> c) { 910 Module m = c.getModule(); 911 // add read edge and qualified export for the target module to access 912 if (!target.canRead(m)) { 913 Modules.addReads(target, m); 914 } 915 String pn = c.getPackageName(); 916 if (!m.isExported(pn, target)) { 917 Modules.addExports(m, pn, target); 918 } 919 } 920 921 /* 922 * Ensure the given class is visible to the class loader. 923 */ 924 static void ensureVisible(ClassLoader ld, Class<?> c) { 925 Class<?> type = null; 926 try { 927 type = Class.forName(c.getName(), false, ld); 928 } catch (ClassNotFoundException e) { 929 } 930 if (type != c) { 931 throw new IllegalArgumentException(c.getName() + 932 " referenced from a method is not visible from class loader"); 933 } 934 } 935 936 static Class<?> getElementType(Class<?> type) { 937 Class<?> e = type; 938 while (e.isArray()) { 939 e = e.getComponentType(); 940 } 941 return e; 942 } 943 944 private static final WeakHashMap<ClassLoader, Module> dynProxyModules = new WeakHashMap<>(); 945 private static final AtomicInteger counter = new AtomicInteger(); 946 947 /* 948 * Define a dynamic module for the generated proxy classes in a non-exported package 949 * named com.sun.proxy.$MODULE. 950 * 951 * Each class loader will have one dynamic module. 952 */ 953 static Module getDynamicModule(ClassLoader loader) { 954 return dynProxyModules.computeIfAbsent(loader, ld -> { 955 // create a dynamic module and setup module access 956 String mn = "jdk.proxy" + counter.incrementAndGet(); 957 String pn = PROXY_PACKAGE_PREFIX + "." + mn; 958 Module m = Modules.defineModule(loader, mn, Collections.singleton(pn)); 959 Modules.addReads(m, Proxy.class.getModule()); 960 // java.base to create proxy instance 961 Modules.addExports(m, pn, Object.class.getModule()); 962 return m; 963 }); 964 } 965 } 966 967 /** 968 * Returns a proxy instance for the specified interfaces 969 * that dispatches method invocations to the specified invocation 970 * handler. 971 * <p> 972 * <a name="restrictions">{@code IllegalArgumentException} will be thrown 973 * if any of the following restrictions is violated:</a> 974 * <ul> 975 * <li>All of {@code Class} objects in the given {@code interfaces} array 976 * must represent interfaces, not classes or primitive types. 977 * 978 * <li>No two elements in the {@code interfaces} array may 979 * refer to identical {@code Class} objects. 980 * 981 * <li>All of the interface types must be visible by name through the 982 * specified class loader. In other words, for class loader 983 * {@code cl} and every interface {@code i}, the following 984 * expression must be true:<p> 985 * {@code Class.forName(i.getName(), false, cl) == i} 986 * 987 * <li>All of the types referenced by all 988 * public method signatures of the specified interfaces 989 * and those inherited by their superinterfaces 990 * must be visible by name through the specified class loader. 991 * 992 * <li>All non-public interfaces must be in the same package 993 * and module, defined by the specified class loader and 994 * the module of the non-public interfaces can access all of 995 * the interface types; otherwise, it would not be possible for 996 * the proxy class to implement all of the interfaces, 997 * regardless of what package it is defined in. 998 * 999 * <li>For any set of member methods of the specified interfaces 1000 * that have the same signature: 1001 * <ul> 1002 * <li>If the return type of any of the methods is a primitive 1003 * type or void, then all of the methods must have that same 1004 * return type. 1005 * <li>Otherwise, one of the methods must have a return type that 1006 * is assignable to all of the return types of the rest of the 1007 * methods. 1008 * </ul> 1009 * 1010 * <li>The resulting proxy class must not exceed any limits imposed 1011 * on classes by the virtual machine. For example, the VM may limit 1012 * the number of interfaces that a class may implement to 65535; in 1013 * that case, the size of the {@code interfaces} array must not 1014 * exceed 65535. 1015 * </ul> 1016 * 1017 * <p>Note that the order of the specified proxy interfaces is 1018 * significant: two requests for a proxy class with the same combination 1019 * of interfaces but in a different order will result in two distinct 1020 * proxy classes. 1021 * 1022 * @param loader the class loader to define the proxy class 1023 * @param interfaces the list of interfaces for the proxy class 1024 * to implement 1025 * @param h the invocation handler to dispatch method invocations to 1026 * @return a proxy instance with the specified invocation handler of a 1027 * proxy class that is defined by the specified class loader 1028 * and that implements the specified interfaces 1029 * @throws IllegalArgumentException if any of the <a href="#restrictions"> 1030 * restrictions</a> on the parameters are violated 1031 * @throws SecurityException if a security manager, <em>s</em>, is present 1032 * and any of the following conditions is met: 1033 * <ul> 1034 * <li> the given {@code loader} is {@code null} and 1035 * the caller's class loader is not {@code null} and the 1036 * invocation of {@link SecurityManager#checkPermission 1037 * s.checkPermission} with 1038 * {@code RuntimePermission("getClassLoader")} permission 1039 * denies access;</li> 1040 * <li> for each proxy interface, {@code intf}, 1041 * the caller's class loader is not the same as or an 1042 * ancestor of the class loader for {@code intf} and 1043 * invocation of {@link SecurityManager#checkPackageAccess 1044 * s.checkPackageAccess()} denies access to {@code intf};</li> 1045 * <li> any of the given proxy interfaces is non-public and the 1046 * caller class is not in the same {@linkplain Package runtime package} 1047 * as the non-public interface and the invocation of 1048 * {@link SecurityManager#checkPermission s.checkPermission} with 1049 * {@code ReflectPermission("newProxyInPackage.{package name}")} 1050 * permission denies access.</li> 1051 * </ul> 1052 * @throws NullPointerException if the {@code interfaces} array 1053 * argument or any of its elements are {@code null}, or 1054 * if the invocation handler, {@code h}, is 1055 * {@code null} 1056 * 1057 * @see <a href="#membership">Package and Module Membership of Proxy Class</a> 1058 */ 1059 @CallerSensitive 1060 public static Object newProxyInstance(ClassLoader loader, 1061 Class<?>[] interfaces, 1062 InvocationHandler h) { 1063 Objects.requireNonNull(h); 1064 1065 final List<Class<?>> intfs = List.of(interfaces); // interfaces cloned 1066 final SecurityManager sm = System.getSecurityManager(); 1067 final Class<?> caller = Reflection.getCallerClass(); 1068 if (sm != null) { 1069 checkProxyAccess(caller, loader, intfs); 1070 } 1071 1072 /* 1073 * Look up or generate the designated proxy class. 1074 */ 1075 Class<?> cl = new ProxyBuilder(loader, intfs).build(); 1076 1077 return newProxyInstance(cl, caller, h); 1078 } 1079 1080 private static Object newProxyInstance(Class<?> proxyClass, Class<?> caller, InvocationHandler h) { 1081 /* 1082 * Invoke its constructor with the designated invocation handler. 1083 */ 1084 try { 1085 final SecurityManager sm = System.getSecurityManager(); 1086 if (sm != null) { 1087 checkNewProxyPermission(caller, proxyClass); 1088 } 1089 1090 final Constructor<?> cons = proxyClass.getConstructor(constructorParams); 1091 AccessController.doPrivileged(new PrivilegedAction<Void>() { 1092 public Void run() { 1093 cons.setAccessible(true); 1094 return null; 1095 } 1096 }); 1097 return cons.newInstance(new Object[]{h}); 1098 } catch (IllegalAccessException | InstantiationException | NoSuchMethodException e) { 1099 throw new InternalError(e.toString(), e); 1100 } catch (InvocationTargetException e) { 1101 Throwable t = e.getCause(); 1102 if (t instanceof RuntimeException) { 1103 throw (RuntimeException) t; 1104 } else { 1105 throw new InternalError(t.toString(), t); 1106 } 1107 } 1108 } 1109 1110 private static void checkNewProxyPermission(Class<?> caller, Class<?> proxyClass) { 1111 SecurityManager sm = System.getSecurityManager(); 1112 if (sm != null) { 1113 if (ReflectUtil.isNonPublicProxyClass(proxyClass)) { 1114 ClassLoader ccl = caller.getClassLoader(); 1115 ClassLoader pcl = proxyClass.getClassLoader(); 1116 1117 // do permission check if the caller is in a different runtime package 1118 // of the proxy class 1119 int n = proxyClass.getName().lastIndexOf('.'); 1120 String pkg = (n == -1) ? "" : proxyClass.getName().substring(0, n); 1121 1122 n = caller.getName().lastIndexOf('.'); 1123 String callerPkg = (n == -1) ? "" : caller.getName().substring(0, n); 1124 1125 if (pcl != ccl || !pkg.equals(callerPkg)) { 1126 sm.checkPermission(new ReflectPermission("newProxyInPackage." + pkg)); 1127 } 1128 } 1129 } 1130 } 1131 1132 /** 1133 * Returns the class loader for the given module. 1134 */ 1135 private static ClassLoader getLoader(Module m) { 1136 PrivilegedAction<ClassLoader> pa = m::getClassLoader; 1137 return AccessController.doPrivileged(pa); 1138 } 1139 1140 /** 1141 * Returns true if the given class is a proxy class. 1142 * 1143 * @implNote The reliability of this method is important for the ability 1144 * to use it to make security decisions, so its implementation should 1145 * not just test if the class in question extends {@code Proxy}. 1146 * 1147 * @param cl the class to test 1148 * @return {@code true} if the class is a proxy class and 1149 * {@code false} otherwise 1150 * @throws NullPointerException if {@code cl} is {@code null} 1151 */ 1152 public static boolean isProxyClass(Class<?> cl) { 1153 return Proxy.class.isAssignableFrom(cl) && ProxyClassFactory.isProxyClass(cl); 1154 } 1155 1156 /** 1157 * Returns the invocation handler for the specified proxy instance. 1158 * 1159 * @param proxy the proxy instance to return the invocation handler for 1160 * @return the invocation handler for the proxy instance 1161 * @throws IllegalArgumentException if the argument is not a 1162 * proxy instance 1163 * @throws SecurityException if a security manager, <em>s</em>, is present 1164 * and the caller's class loader is not the same as or an 1165 * ancestor of the class loader for the invocation handler 1166 * and invocation of {@link SecurityManager#checkPackageAccess 1167 * s.checkPackageAccess()} denies access to the invocation 1168 * handler's class. 1169 */ 1170 @CallerSensitive 1171 public static InvocationHandler getInvocationHandler(Object proxy) 1172 throws IllegalArgumentException 1173 { 1174 /* 1175 * Verify that the object is actually a proxy instance. 1176 */ 1177 if (!isProxyClass(proxy.getClass())) { 1178 throw new IllegalArgumentException("not a proxy instance"); 1179 } 1180 1181 final Proxy p = (Proxy) proxy; 1182 final InvocationHandler ih = p.h; 1183 if (System.getSecurityManager() != null) { 1184 Class<?> ihClass = ih.getClass(); 1185 Class<?> caller = Reflection.getCallerClass(); 1186 if (ReflectUtil.needsPackageAccessCheck(caller.getClassLoader(), 1187 ihClass.getClassLoader())) 1188 { 1189 ReflectUtil.checkPackageAccess(ihClass); 1190 } 1191 } 1192 1193 return ih; 1194 } 1195 1196 private static final Class<?>[] EMPTY_CLASS_ARRAY = new Class<?>[0]; 1197 private static final String PROXY_PACKAGE_PREFIX = ReflectUtil.PROXY_PACKAGE; 1198 }