1 /*
2 * Copyright (c) 2021, 2025, 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.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #include "cds/aotClassLocation.hpp"
26 #include "cds/cdsConfig.hpp"
27 #include "cds/cdsProtectionDomain.hpp"
28 #include "classfile/classLoader.hpp"
29 #include "classfile/classLoaderData.inline.hpp"
30 #include "classfile/javaClasses.hpp"
31 #include "classfile/moduleEntry.hpp"
32 #include "classfile/systemDictionaryShared.hpp"
33 #include "classfile/vmClasses.hpp"
34 #include "classfile/vmSymbols.hpp"
35 #include "memory/oopFactory.hpp"
36 #include "memory/resourceArea.hpp"
37 #include "memory/universe.hpp"
38 #include "oops/instanceKlass.hpp"
39 #include "oops/symbol.hpp"
40 #include "runtime/javaCalls.hpp"
41
42 OopHandle CDSProtectionDomain::_shared_protection_domains;
43 OopHandle CDSProtectionDomain::_shared_jar_urls;
44 OopHandle CDSProtectionDomain::_shared_jar_manifests;
45
46 // Initializes the java.lang.Package and java.security.ProtectionDomain objects associated with
47 // the given InstanceKlass.
48 // Returns the ProtectionDomain for the InstanceKlass.
49 Handle CDSProtectionDomain::init_security_info(Handle class_loader, InstanceKlass* ik, PackageEntry* pkg_entry, TRAPS) {
50 int index = ik->shared_classpath_index();
51 assert(index >= 0, "Sanity");
52 const AOTClassLocation* cl = AOTClassLocationConfig::runtime()->class_location_at(index);
53 Symbol* class_name = ik->name();
54
55 if (cl->is_modules_image()) {
56 // For shared app/platform classes originated from the run-time image:
57 // The ProtectionDomains are cached in the corresponding ModuleEntries
58 // for fast access by the VM.
59 // all packages from module image are already created during VM bootstrap in
60 // Modules::define_module().
61 assert(pkg_entry != nullptr, "archived class in module image cannot be from unnamed package");
62 ModuleEntry* mod_entry = pkg_entry->module();
63 return get_shared_protection_domain(class_loader, mod_entry, THREAD);
64 } else {
65 // For shared app/platform classes originated from JAR files on the class path:
66 // Each of the 3 CDSProtectionDomain::_shared_xxx arrays has the same length
67 // as the shared classpath table in the shared archive.
68 //
69 // If a shared InstanceKlass k is loaded from the class path, let
70 //
71 // index = k->shared_classpath_index();
72 //
73 // AOTClassLocationConfig::_runtime_instance->_array->at(index) identifies the JAR file that contains k.
74 //
75 // k's protection domain is:
76 //
77 // ProtectionDomain pd = _shared_protection_domains[index];
78 //
79 // and k's Package is initialized using
80 //
81 // manifest = _shared_jar_manifests[index];
82 // url = _shared_jar_urls[index];
83 // define_shared_package(class_name, class_loader, manifest, url, CHECK_NH);
84 //
85 // Note that if an element of these 3 _shared_xxx arrays is null, it will be initialized by
86 // the corresponding CDSProtectionDomain::get_shared_xxx() function.
87 Handle manifest = get_shared_jar_manifest(index, CHECK_NH);
88 Handle url = get_shared_jar_url(index, CHECK_NH);
89 int index_offset = index - AOTClassLocationConfig::runtime()->app_cp_start_index();
90 if (index_offset < PackageEntry::max_index_for_defined_in_class_path()) {
91 if (pkg_entry == nullptr || !pkg_entry->is_defined_by_cds_in_class_path(index_offset)) {
92 // define_shared_package only needs to be called once for each package in a jar specified
93 // in the shared class path.
94 define_shared_package(class_name, class_loader, manifest, url, CHECK_NH);
95 if (pkg_entry != nullptr) {
96 pkg_entry->set_defined_by_cds_in_class_path(index_offset);
97 }
98 }
99 } else {
100 define_shared_package(class_name, class_loader, manifest, url, CHECK_NH);
101 }
102 return get_shared_protection_domain(class_loader, index, url, THREAD);
103 }
104 }
105
106 Handle CDSProtectionDomain::get_package_name(Symbol* class_name, TRAPS) {
107 ResourceMark rm(THREAD);
108 Handle pkgname_string;
109 TempNewSymbol pkg = ClassLoader::package_from_class_name(class_name);
110 if (pkg != nullptr) { // Package prefix found
111 const char* pkgname = pkg->as_klass_external_name();
112 pkgname_string = java_lang_String::create_from_str(pkgname,
113 CHECK_(pkgname_string));
114 }
115 return pkgname_string;
116 }
117
118 PackageEntry* CDSProtectionDomain::get_package_entry_from_class(InstanceKlass* ik, Handle class_loader) {
119 PackageEntry* pkg_entry = ik->package();
120 if (CDSConfig::is_using_full_module_graph() && ik->is_shared() && pkg_entry != nullptr) {
121 assert(MetaspaceShared::is_in_shared_metaspace(pkg_entry), "must be");
122 assert(!ik->defined_by_other_loaders(), "unexpected archived package entry for an unregistered class");
123 return pkg_entry;
124 }
125 TempNewSymbol pkg_name = ClassLoader::package_from_class_name(ik->name());
126 if (pkg_name != nullptr) {
127 pkg_entry = ClassLoaderData::class_loader_data(class_loader())->packages()->lookup_only(pkg_name);
128 } else {
129 pkg_entry = nullptr;
130 }
131 return pkg_entry;
132 }
133
134 // Define Package for shared app classes from JAR file and also checks for
135 // package sealing (all done in Java code)
136 // See http://docs.oracle.com/javase/tutorial/deployment/jar/sealman.html
137 void CDSProtectionDomain::define_shared_package(Symbol* class_name,
138 Handle class_loader,
139 Handle manifest,
140 Handle url,
141 TRAPS) {
142 assert(SystemDictionary::is_system_class_loader(class_loader()), "unexpected class loader");
143 // get_package_name() returns a null handle if the class is in unnamed package
144 Handle pkgname_string = get_package_name(class_name, CHECK);
145 if (pkgname_string.not_null()) {
146 Klass* app_classLoader_klass = vmClasses::jdk_internal_loader_ClassLoaders_AppClassLoader_klass();
147 JavaValue result(T_OBJECT);
148 JavaCallArguments args(3);
149 args.set_receiver(class_loader);
150 args.push_oop(pkgname_string);
151 args.push_oop(manifest);
152 args.push_oop(url);
153 JavaCalls::call_virtual(&result, app_classLoader_klass,
154 vmSymbols::defineOrCheckPackage_name(),
155 vmSymbols::defineOrCheckPackage_signature(),
156 &args,
157 CHECK);
158 }
159 }
160
161 Handle CDSProtectionDomain::create_jar_manifest(const char* manifest_chars, size_t size, TRAPS) {
162 typeArrayOop buf = oopFactory::new_byteArray((int)size, CHECK_NH);
163 typeArrayHandle bufhandle(THREAD, buf);
164 ArrayAccess<>::arraycopy_from_native(reinterpret_cast<const jbyte*>(manifest_chars),
165 buf, typeArrayOopDesc::element_offset<jbyte>(0), size);
166 Handle bais = JavaCalls::construct_new_instance(vmClasses::ByteArrayInputStream_klass(),
167 vmSymbols::byte_array_void_signature(),
168 bufhandle, CHECK_NH);
169 // manifest = new Manifest(ByteArrayInputStream)
170 Handle manifest = JavaCalls::construct_new_instance(vmClasses::Jar_Manifest_klass(),
171 vmSymbols::input_stream_void_signature(),
172 bais, CHECK_NH);
173 return manifest;
174 }
175
176 Handle CDSProtectionDomain::get_shared_jar_manifest(int shared_path_index, TRAPS) {
177 Handle manifest;
178 if (shared_jar_manifest(shared_path_index) == nullptr) {
179 const AOTClassLocation* cl = AOTClassLocationConfig::runtime()->class_location_at(shared_path_index);
180 size_t size = cl->manifest_length();
181 if (size == 0) {
182 return Handle();
183 }
184
185 // ByteArrayInputStream bais = new ByteArrayInputStream(buf);
186 const char* src = cl->manifest();
187 assert(src != nullptr, "No Manifest data");
188 manifest = create_jar_manifest(src, size, CHECK_NH);
189 atomic_set_shared_jar_manifest(shared_path_index, manifest());
190 }
191 manifest = Handle(THREAD, shared_jar_manifest(shared_path_index));
192 assert(manifest.not_null(), "sanity");
193 return manifest;
194 }
195
196 Handle CDSProtectionDomain::get_shared_jar_url(int shared_path_index, TRAPS) {
197 Handle url_h;
198 if (shared_jar_url(shared_path_index) == nullptr) {
199 const char* path = AOTClassLocationConfig::runtime()->class_location_at(shared_path_index)->path();
200 oop result_oop = to_file_URL(path, url_h, CHECK_(url_h));
201 atomic_set_shared_jar_url(shared_path_index, result_oop);
202 }
203
204 url_h = Handle(THREAD, shared_jar_url(shared_path_index));
205 assert(url_h.not_null(), "sanity");
206 return url_h;
207 }
208
209 oop CDSProtectionDomain::to_file_URL(const char* path, Handle url_h, TRAPS) {
210 JavaValue result(T_OBJECT);
211 Handle path_string = java_lang_String::create_from_str(path, CHECK_NULL);
212 JavaCalls::call_static(&result,
213 vmClasses::jdk_internal_loader_ClassLoaders_klass(),
214 vmSymbols::toFileURL_name(),
215 vmSymbols::toFileURL_signature(),
216 path_string, CHECK_NULL);
217 return result.get_oop();
218 }
219
220 // Get the ProtectionDomain associated with the CodeSource from the classloader.
221 Handle CDSProtectionDomain::get_protection_domain_from_classloader(Handle class_loader,
222 Handle url, TRAPS) {
223 // CodeSource cs = new CodeSource(url, null);
224 Handle cs = JavaCalls::construct_new_instance(vmClasses::CodeSource_klass(),
225 vmSymbols::url_code_signer_array_void_signature(),
226 url, Handle(), CHECK_NH);
227
228 // protection_domain = SecureClassLoader.getProtectionDomain(cs);
229 Klass* secureClassLoader_klass = vmClasses::SecureClassLoader_klass();
230 JavaValue obj_result(T_OBJECT);
231 JavaCalls::call_virtual(&obj_result, class_loader, secureClassLoader_klass,
232 vmSymbols::getProtectionDomain_name(),
233 vmSymbols::getProtectionDomain_signature(),
234 cs, CHECK_NH);
235 return Handle(THREAD, obj_result.get_oop());
236 }
237
238 // Returns the ProtectionDomain associated with the JAR file identified by the url.
239 Handle CDSProtectionDomain::get_shared_protection_domain(Handle class_loader,
240 int shared_path_index,
241 Handle url,
242 TRAPS) {
243 Handle protection_domain;
244 if (shared_protection_domain(shared_path_index) == nullptr) {
245 Handle pd = get_protection_domain_from_classloader(class_loader, url, CHECK_NH);
246 atomic_set_shared_protection_domain(shared_path_index, pd());
247 }
248
249 // Acquire from the cache because if another thread beats the current one to
250 // set the shared protection_domain and the atomic_set fails, the current thread
251 // needs to get the updated protection_domain from the cache.
252 protection_domain = Handle(THREAD, shared_protection_domain(shared_path_index));
253 assert(protection_domain.not_null(), "sanity");
254 return protection_domain;
255 }
256
257 // Returns the ProtectionDomain associated with the moduleEntry.
258 Handle CDSProtectionDomain::get_shared_protection_domain(Handle class_loader,
259 ModuleEntry* mod, TRAPS) {
260 ClassLoaderData *loader_data = mod->loader_data();
261 if (mod->shared_protection_domain() == nullptr) {
262 Symbol* location = mod->location();
263 if (location != nullptr) {
264 Handle location_string = java_lang_String::create_from_symbol(
265 location, CHECK_NH);
266 Handle url;
267 JavaValue result(T_OBJECT);
268 if (location->starts_with("jrt:/")) {
269 url = JavaCalls::construct_new_instance(vmClasses::URL_klass(),
270 vmSymbols::string_void_signature(),
271 location_string, CHECK_NH);
272 } else {
273 Klass* classLoaders_klass =
274 vmClasses::jdk_internal_loader_ClassLoaders_klass();
275 JavaCalls::call_static(&result, classLoaders_klass, vmSymbols::toFileURL_name(),
276 vmSymbols::toFileURL_signature(),
277 location_string, CHECK_NH);
278 url = Handle(THREAD, result.get_oop());
279 }
280
281 Handle pd = get_protection_domain_from_classloader(class_loader, url,
282 CHECK_NH);
283 mod->set_shared_protection_domain(loader_data, pd);
284 }
285 }
286
287 Handle protection_domain(THREAD, mod->shared_protection_domain());
288 assert(protection_domain.not_null(), "sanity");
289 return protection_domain;
290 }
291
292 void CDSProtectionDomain::atomic_set_array_index(OopHandle array, int index, oop o) {
293 // Benign race condition: array.obj_at(index) may already be filled in.
294 // The important thing here is that all threads pick up the same result.
295 // It doesn't matter which racing thread wins, as long as only one
296 // result is used by all threads, and all future queries.
297 ((objArrayOop)array.resolve())->replace_if_null(index, o);
298 }
299
300 oop CDSProtectionDomain::shared_protection_domain(int index) {
301 return ((objArrayOop)_shared_protection_domains.resolve())->obj_at(index);
302 }
303
304 void CDSProtectionDomain::allocate_shared_protection_domain_array(int size, TRAPS) {
305 if (_shared_protection_domains.resolve() == nullptr) {
306 oop spd = oopFactory::new_objArray(
307 vmClasses::ProtectionDomain_klass(), size, CHECK);
308 _shared_protection_domains = OopHandle(Universe::vm_global(), spd);
309 }
310 }
311
312 oop CDSProtectionDomain::shared_jar_url(int index) {
313 return ((objArrayOop)_shared_jar_urls.resolve())->obj_at(index);
314 }
315
316 void CDSProtectionDomain::allocate_shared_jar_url_array(int size, TRAPS) {
317 if (_shared_jar_urls.resolve() == nullptr) {
318 oop sju = oopFactory::new_objArray(
319 vmClasses::URL_klass(), size, CHECK);
320 _shared_jar_urls = OopHandle(Universe::vm_global(), sju);
321 }
322 }
323
324 oop CDSProtectionDomain::shared_jar_manifest(int index) {
325 return ((objArrayOop)_shared_jar_manifests.resolve())->obj_at(index);
326 }
327
328 void CDSProtectionDomain::allocate_shared_jar_manifest_array(int size, TRAPS) {
329 if (_shared_jar_manifests.resolve() == nullptr) {
330 oop sjm = oopFactory::new_objArray(
331 vmClasses::Jar_Manifest_klass(), size, CHECK);
332 _shared_jar_manifests = OopHandle(Universe::vm_global(), sjm);
333 }
334 }