diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b1ae5ad --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# Java defineClass utility + +**defineClass()** is a **protected** method of the ClassLoader class that allows you to convert a byte array into an +instance of the class '**Class**'. + +I added the ability to use this method in any ClassLoader and extended its functionality. + +## How to use + +```java +/* + * Example of creating a new instance + * of a compiled Test.class + * with defineClass() + */ +try { + Class testClass = Define.defineClass( + getClass().getClassLoader(), + Paths.get("./classes/Test.class")); + testClass.newInstance(); +} catch (Exception e) { + throw new RuntimeException(e); +} +``` +## Open source + +The project is an open source project distributed under the Apache License 2.0
+ +## Getting started + +1. Download the latest build from releases +2. Read the FAQ and examples +3. Enjoy! + +## Status + +The project is in beta. Use at your own risk.
+ diff --git a/classes/Test.class b/classes/Test.class new file mode 100644 index 0000000..97acdf5 Binary files /dev/null and b/classes/Test.class differ diff --git a/src/ua/juniffiro/cl/definecl/Define.java b/src/ua/juniffiro/cl/definecl/Define.java new file mode 100644 index 0000000..90bb69b --- /dev/null +++ b/src/ua/juniffiro/cl/definecl/Define.java @@ -0,0 +1,231 @@ +package ua.juniffiro.cl.definecl; + +import java.io.IOException; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.nio.ByteBuffer; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.security.ProtectionDomain; + +/** + * +-+-+-+-+-+ +-+-+ +-+-+-+-+-+-+-+-+-+ + * ( Created ) ( by ) ( @juniffiro ) + * 27/02/2023 + * +-+-+-+-+-+ +-+-+ +-+-+-+-+-+-+-+-+-+ + */ +public class Define { + + /* + This utility is designed and uses part of + the class loader implementation. + + Java 8 ClassLoader src + https://github.com/zxiaofan/JDK/blob/master/JDK1.8/src/java/lang/ClassLoader.java + */ + + /** + * Converts a ByteBuffer into an instance + * of class 'Class', with an optional + * ProtectionDomain. + * + * @param classLoader + * Target class loader + * @param name + * The expected binary name of the + * class, or null if not known + * @param buf + * ByteBuffer + * @param domain + * The ProtectionDomain of the class, or null. + + * @return Instance of class 'Class'. + * + * @throws InvocationTargetException + * If an error occurs when calling + * a method via Reflection API + * @throws NoSuchMethodException + * If when calling a method via + * Reflection API the method was not found + * @throws IllegalAccessException + * If the Reflection API does not have + * access to the defineClass() method in ClassLoader + */ + public static Class defineClass(ClassLoader classLoader, + String name, + ByteBuffer buf, + ProtectionDomain domain) + throws InvocationTargetException, NoSuchMethodException, IllegalAccessException { + + byte[] data = new byte[buf.remaining()]; + buf.get(data); + + return defineClass(classLoader, name, data, 0, data.length, domain); + } + + /** + * Converts the byte array obtained from + * the compiled class file into an instance + * of the class 'Class', with an optional + * ProtectionDomain. + *

+ * See {@link #defineClass(ClassLoader, String, byte[], int, int, ProtectionDomain)} + * + * @param pathToClass + * Path to compiled class file + * + * See {@link DefineUtils#getBytesOfClass(Path)} + */ + public static Class defineClass(ClassLoader classLoader, + Path pathToClass, + ProtectionDomain domain) + throws NoSuchMethodException, IOException, + InvocationTargetException, IllegalAccessException { + + byte[] data = DefineUtils.getBytesOfClass(pathToClass); + + return defineClass(classLoader, null, data, 0, data.length, domain); + } + + /** + * Converts the byte array obtained from + * the compiled class file into an instance + * of the class 'Class', with the ProtectionDomain + * obtained from the CodeSource file. + *

+ * See {@link #defineClass(ClassLoader, Path, ProtectionDomain)} + */ + public static Class defineClass(ClassLoader classLoader, Path pathToClass) + throws NoSuchMethodException, IOException, InvocationTargetException, + IllegalAccessException { + + return defineClass(classLoader, pathToClass, new ProtectionDomain( + DefineUtils.getCodeSource(pathToClass), null)); + } + + /** + * A method similar to + * {@link #defineClass(ClassLoader, Path, ProtectionDomain)} + * but takes the path to the file as a + * String instead of the Path parameter. + * + * @param pathToClass + * String type + * Path to compiled class file + */ + public static Class defineClass(ClassLoader classLoader, + String pathToClass, + ProtectionDomain domain) + throws IOException, InvocationTargetException, NoSuchMethodException, + IllegalAccessException { + + return defineClass(classLoader, Paths.get(pathToClass), domain); + } + + /** + * A method similar to + * {@link #defineClass(ClassLoader, Path)} + * but takes the path to the class as a + * String instead of the Path parameter. + * + * @param pathToClass + * String type + * Path to compiled class file + */ + public static Class defineClass(ClassLoader classLoader, String pathToClass) + throws NoSuchMethodException, IOException, + InvocationTargetException, IllegalAccessException { + + return defineClass(classLoader, Paths.get(pathToClass)); + } + + /** + * Converts an array of bytes into an instance + * of the class 'Class' without ProtectionDomain + * (StaticData.defaultProtectionDomain) + *

+ * See {@link #defineClass(ClassLoader, String, byte[], int, int)} + */ + public static Class defineClass(ClassLoader classLoader, + String name, + byte[] data, + int offset, + int len) + throws NoSuchMethodException, InvocationTargetException, IllegalAccessException { + + return defineClass(classLoader, name, data, offset, len, null); + } + + /** + * Converts an array of bytes into an instance + * of the class 'Class'. + * Deprecated method and not recommended for use. + *

+ * See {@link #defineClass(ClassLoader, String, byte[], int, int)} + */ + @Deprecated + public static Class defineClass(ClassLoader classLoader, + byte[] data, + int offset, + int len) + throws NoSuchMethodException, InvocationTargetException, IllegalAccessException { + + return defineClass(classLoader, null, data, offset, len); + } + + /** + * Converts an array of bytes into an instance + * of the class 'Class' with an optional + * ProtectionDomain, using the Reflection API. + * + * @param classLoader + * Target class loader + * @param name + * The expected binary name of the + * class, or null if not known + * @param data + * The bytes that make up the class data + * @param offset + * The start offset in b of the class data + * @param len + * The length of the class data + * @param domain + * The ProtectionDomain of the class, or null. + * + * @return Instance of class 'Class'. + * + * @throws InvocationTargetException + * If an error occurs when calling + * a method via Reflection API + * @throws NoSuchMethodException + * If when calling a method via + * Reflection API the method was not found + * @throws IllegalAccessException + * If the Reflection API does not have + * access to the defineClass() method in ClassLoader + */ + public static Class defineClass(ClassLoader classLoader, + String name, + byte[] data, + int offset, + int len, + ProtectionDomain domain) + throws NoSuchMethodException, InvocationTargetException, IllegalAccessException { + + Method method = ClassLoader.class.getDeclaredMethod( + "defineClass", + String.class, + byte[].class, + int.class, + int.class, + ProtectionDomain.class); + method.setAccessible(true); + + Class clazz = (Class) method.invoke(classLoader, new Object[]{ + name, data, offset, len, domain + }); + method.setAccessible(false); + + return clazz; + } +} diff --git a/src/ua/juniffiro/cl/definecl/DefineUtils.java b/src/ua/juniffiro/cl/definecl/DefineUtils.java new file mode 100644 index 0000000..07912fc --- /dev/null +++ b/src/ua/juniffiro/cl/definecl/DefineUtils.java @@ -0,0 +1,51 @@ +package ua.juniffiro.cl.definecl; + +import java.io.IOException; +import java.net.MalformedURLException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.security.CodeSigner; +import java.security.CodeSource; + +/** + * +-+-+-+-+-+ +-+-+ +-+-+-+-+-+-+-+-+-+ + * ( Created ) ( by ) ( @juniffiro ) + * 10/03/2023 + * +-+-+-+-+-+ +-+-+ +-+-+-+-+-+-+-+-+-+ + */ +public class DefineUtils { + + /** + * Get CodeSource from the class file. + * + * @param pathToClass + * Path to compiled class file + * + * @return Code source of class. + * @throws MalformedURLException + * Thrown to indicate that a malformed + * URL has occurred. + */ + public static CodeSource getCodeSource(Path pathToClass) throws MalformedURLException { + return new CodeSource(pathToClass + .toFile() + .toURI() + .toURL(), + new CodeSigner[0]); + } + + /** + * Get an array of bytes from the class file. + * + * @param pathToClass + * Path to class file + * @return Byte array of class file. + * + * @throws IOException + * If the class file is not found or + * there are other problems with the file + */ + public static byte[] getBytesOfClass(Path pathToClass) throws IOException { + return Files.readAllBytes(pathToClass); + } +}