1 /*
2  * Copyright (C) 2017 The Android Open Source Project
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *  * Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *  * Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in
12  *    the documentation and/or other materials provided with the
13  *    distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <stdlib.h>
30 #include <string.h>
31 #include <sys/mman.h>
32 
33 #include <gtest/gtest.h>
34 
35 #include "linker_config.h"
36 #include "linker_utils.h"
37 
38 #include <unistd.h>
39 
40 #include <android-base/file.h>
41 #include <android-base/scopeguard.h>
42 #include <android-base/stringprintf.h>
43 
44 #if defined(__LP64__)
45 #define ARCH_SUFFIX "64"
46 #else
47 #define ARCH_SUFFIX ""
48 #endif
49 
50 // clang-format off
51 static const char* config_str =
52   "# comment \n"
53   "dir.test = /data/local/tmp\n"
54   "\n"
55   "[test]\n"
56   "\n"
57   "enable.target.sdk.version = true\n"
58   "additional.namespaces=system\n"
59   "additional.namespaces+=vndk\n"
60   "additional.namespaces+=vndk_in_system\n"
61   "namespace.default.isolated = true\n"
62   "namespace.default.search.paths = /vendor/${LIB}\n"
63   "namespace.default.permitted.paths = /vendor/${LIB}\n"
64   "namespace.default.asan.search.paths = /data\n"
65   "namespace.default.asan.search.paths += /vendor/${LIB}\n"
66   "namespace.default.asan.permitted.paths = /data:/vendor\n"
67   "namespace.default.links = system\n"
68   "namespace.default.links += vndk\n"
69   // irregular whitespaces are added intentionally for testing purpose
70   "namespace.default.link.system.shared_libs=  libc.so\n"
71   "namespace.default.link.system.shared_libs +=   libm.so:libdl.so\n"
72   "namespace.default.link.system.shared_libs   +=libstdc++.so\n"
73   "namespace.default.link.vndk.shared_libs = libcutils.so:libbase.so\n"
74   "namespace.system.isolated = true\n"
75   "namespace.system.visible = true\n"
76   "namespace.system.search.paths = /system/${LIB}\n"
77   "namespace.system.permitted.paths = /system/${LIB}\n"
78   "namespace.system.asan.search.paths = /data:/system/${LIB}\n"
79   "namespace.system.asan.permitted.paths = /data:/system\n"
80   "namespace.vndk.isolated = tr\n"
81   "namespace.vndk.isolated += ue\n" // should be ignored and return as 'false'.
82   "namespace.vndk.search.paths = /system/${LIB}/vndk\n"
83   "namespace.vndk.asan.search.paths = /data\n"
84   "namespace.vndk.asan.search.paths += /system/${LIB}/vndk\n"
85   "namespace.vndk.links = default\n"
86   "namespace.vndk.link.default.allow_all_shared_libs = true\n"
87   "namespace.vndk.link.vndk_in_system.allow_all_shared_libs = true\n"
88   "namespace.vndk_in_system.isolated = true\n"
89   "namespace.vndk_in_system.visible = true\n"
90   "namespace.vndk_in_system.search.paths = /system/${LIB}\n"
91   "namespace.vndk_in_system.permitted.paths = /system/${LIB}\n"
92   "namespace.vndk_in_system.whitelisted = libz.so:libyuv.so\n"
93   "namespace.vndk_in_system.whitelisted += libtinyxml2.so\n"
94   "\n";
95 // clang-format on
96 
write_version(const std::string & path,uint32_t version)97 static bool write_version(const std::string& path, uint32_t version) {
98   std::string content = android::base::StringPrintf("%d", version);
99   return android::base::WriteStringToFile(content, path);
100 }
101 
resolve_paths(std::vector<std::string> paths)102 static std::vector<std::string> resolve_paths(std::vector<std::string> paths) {
103   std::vector<std::string> resolved_paths;
104   resolve_paths(paths, &resolved_paths);
105   return resolved_paths;
106 }
107 
run_linker_config_smoke_test(bool is_asan)108 static void run_linker_config_smoke_test(bool is_asan) {
109   const std::vector<std::string> kExpectedDefaultSearchPath =
110       resolve_paths(is_asan ? std::vector<std::string>({ "/data", "/vendor/lib" ARCH_SUFFIX }) :
111                               std::vector<std::string>({ "/vendor/lib" ARCH_SUFFIX }));
112 
113   const std::vector<std::string> kExpectedDefaultPermittedPath =
114       resolve_paths(is_asan ? std::vector<std::string>({ "/data", "/vendor" }) :
115                               std::vector<std::string>({ "/vendor/lib" ARCH_SUFFIX }));
116 
117   const std::vector<std::string> kExpectedSystemSearchPath =
118       resolve_paths(is_asan ? std::vector<std::string>({ "/data", "/system/lib" ARCH_SUFFIX }) :
119                               std::vector<std::string>({ "/system/lib" ARCH_SUFFIX }));
120 
121   const std::vector<std::string> kExpectedSystemPermittedPath =
122       resolve_paths(is_asan ? std::vector<std::string>({ "/data", "/system" }) :
123                               std::vector<std::string>({ "/system/lib" ARCH_SUFFIX }));
124 
125   const std::vector<std::string> kExpectedVndkSearchPath =
126       resolve_paths(is_asan ? std::vector<std::string>({ "/data", "/system/lib" ARCH_SUFFIX "/vndk"}) :
127                               std::vector<std::string>({ "/system/lib" ARCH_SUFFIX "/vndk"}));
128 
129   TemporaryFile tmp_file;
130   close(tmp_file.fd);
131   tmp_file.fd = -1;
132 
133   android::base::WriteStringToFile(config_str, tmp_file.path);
134 
135   TemporaryDir tmp_dir;
136 
137   std::string executable_path = std::string(tmp_dir.path) + "/some-binary";
138   std::string version_file = std::string(tmp_dir.path) + "/.version";
139 
140   auto file_guard =
141       android::base::make_scope_guard([&version_file] { unlink(version_file.c_str()); });
142 
143   ASSERT_TRUE(write_version(version_file, 113U)) << strerror(errno);
144 
145   // read config
146   const Config* config = nullptr;
147   std::string error_msg;
148   ASSERT_TRUE(Config::read_binary_config(tmp_file.path,
149                                          executable_path.c_str(),
150                                          is_asan,
151                                          &config,
152                                          &error_msg)) << error_msg;
153   ASSERT_TRUE(config != nullptr);
154   ASSERT_TRUE(error_msg.empty());
155 
156   ASSERT_EQ(113, config->target_sdk_version());
157 
158   const NamespaceConfig* default_ns_config = config->default_namespace_config();
159   ASSERT_TRUE(default_ns_config != nullptr);
160 
161   ASSERT_TRUE(default_ns_config->isolated());
162   ASSERT_FALSE(default_ns_config->visible());
163   ASSERT_EQ(kExpectedDefaultSearchPath, default_ns_config->search_paths());
164   ASSERT_EQ(kExpectedDefaultPermittedPath, default_ns_config->permitted_paths());
165 
166   const auto& default_ns_links = default_ns_config->links();
167   ASSERT_EQ(2U, default_ns_links.size());
168 
169   ASSERT_EQ("system", default_ns_links[0].ns_name());
170   ASSERT_EQ("libc.so:libm.so:libdl.so:libstdc++.so", default_ns_links[0].shared_libs());
171   ASSERT_FALSE(default_ns_links[0].allow_all_shared_libs());
172 
173   ASSERT_EQ("vndk", default_ns_links[1].ns_name());
174   ASSERT_EQ("libcutils.so:libbase.so", default_ns_links[1].shared_libs());
175   ASSERT_FALSE(default_ns_links[1].allow_all_shared_libs());
176 
177   auto& ns_configs = config->namespace_configs();
178   ASSERT_EQ(4U, ns_configs.size());
179 
180   // find second namespace
181   const NamespaceConfig* ns_system = nullptr;
182   const NamespaceConfig* ns_vndk = nullptr;
183   const NamespaceConfig* ns_vndk_in_system = nullptr;
184   for (auto& ns : ns_configs) {
185     std::string ns_name = ns->name();
186     ASSERT_TRUE(ns_name == "system" || ns_name == "default" ||
187                 ns_name == "vndk" || ns_name == "vndk_in_system")
188         << "unexpected ns name: " << ns->name();
189 
190     if (ns_name == "system") {
191       ns_system = ns.get();
192     } else if (ns_name == "vndk") {
193       ns_vndk = ns.get();
194     } else if (ns_name == "vndk_in_system") {
195       ns_vndk_in_system = ns.get();
196     }
197   }
198 
199   ASSERT_TRUE(ns_system != nullptr) << "system namespace was not found";
200 
201   ASSERT_TRUE(ns_system->isolated());
202   ASSERT_TRUE(ns_system->visible());
203   ASSERT_EQ(kExpectedSystemSearchPath, ns_system->search_paths());
204   ASSERT_EQ(kExpectedSystemPermittedPath, ns_system->permitted_paths());
205 
206   ASSERT_TRUE(ns_vndk != nullptr) << "vndk namespace was not found";
207 
208   ASSERT_FALSE(ns_vndk->isolated()); // malformed bool property
209   ASSERT_FALSE(ns_vndk->visible()); // undefined bool property
210   ASSERT_EQ(kExpectedVndkSearchPath, ns_vndk->search_paths());
211 
212   const auto& ns_vndk_links = ns_vndk->links();
213   ASSERT_EQ(1U, ns_vndk_links.size());
214   ASSERT_EQ("default", ns_vndk_links[0].ns_name());
215   ASSERT_TRUE(ns_vndk_links[0].allow_all_shared_libs());
216 
217   ASSERT_TRUE(ns_vndk_in_system != nullptr) << "vndk_in_system namespace was not found";
218   ASSERT_EQ(
219       std::vector<std::string>({"libz.so", "libyuv.so", "libtinyxml2.so"}),
220       ns_vndk_in_system->whitelisted_libs());
221 }
222 
TEST(linker_config,smoke)223 TEST(linker_config, smoke) {
224   run_linker_config_smoke_test(false);
225 }
226 
TEST(linker_config,asan_smoke)227 TEST(linker_config, asan_smoke) {
228   run_linker_config_smoke_test(true);
229 }
230 
TEST(linker_config,ns_link_shared_libs_invalid_settings)231 TEST(linker_config, ns_link_shared_libs_invalid_settings) {
232   // This unit test ensures an error is emitted when a namespace link in ld.config.txt specifies
233   // both shared_libs and allow_all_shared_libs.
234 
235   static const char config_str[] =
236     "dir.test = /data/local/tmp\n"
237     "\n"
238     "[test]\n"
239     "additional.namespaces = system\n"
240     "namespace.default.links = system\n"
241     "namespace.default.link.system.shared_libs = libc.so:libm.so\n"
242     "namespace.default.link.system.allow_all_shared_libs = true\n"
243     "\n";
244 
245   TemporaryFile tmp_file;
246   close(tmp_file.fd);
247   tmp_file.fd = -1;
248 
249   android::base::WriteStringToFile(config_str, tmp_file.path);
250 
251   TemporaryDir tmp_dir;
252 
253   std::string executable_path = std::string(tmp_dir.path) + "/some-binary";
254 
255   const Config* config = nullptr;
256   std::string error_msg;
257   ASSERT_FALSE(Config::read_binary_config(tmp_file.path,
258                                           executable_path.c_str(),
259                                           false,
260                                           &config,
261                                           &error_msg));
262   ASSERT_TRUE(config == nullptr);
263   ASSERT_EQ(std::string(tmp_file.path) + ":6: "
264             "error: both shared_libs and allow_all_shared_libs are set for default->system link.",
265             error_msg);
266 }
267 
TEST(linker_config,dir_path_resolve)268 TEST(linker_config, dir_path_resolve) {
269   // This unit test ensures the linker resolves paths of dir.${section}
270   // properties to real path.
271 
272   TemporaryDir tmp_dir;
273 
274   std::string sub_dir = std::string(tmp_dir.path) + "/subdir";
275   mkdir(sub_dir.c_str(), 0755);
276 
277   auto subdir_guard =
278       android::base::make_scope_guard([&sub_dir] { rmdir(sub_dir.c_str()); });
279 
280   std::string symlink_path = std::string(tmp_dir.path) + "/symlink";
281   symlink(sub_dir.c_str(), symlink_path.c_str());
282 
283   auto symlink_guard =
284       android::base::make_scope_guard([&symlink_path] { unlink(symlink_path.c_str()); });
285 
286   std::string config_str =
287       "dir.test = " + symlink_path + "\n"
288       "\n"
289       "[test]\n";
290 
291   TemporaryFile tmp_file;
292   close(tmp_file.fd);
293   tmp_file.fd = -1;
294 
295   android::base::WriteStringToFile(config_str, tmp_file.path);
296 
297   std::string executable_path = sub_dir + "/some-binary";
298 
299   const Config* config = nullptr;
300   std::string error_msg;
301 
302   ASSERT_TRUE(Config::read_binary_config(tmp_file.path,
303                                          executable_path.c_str(),
304                                          false,
305                                          &config,
306                                          &error_msg)) << error_msg;
307 
308   ASSERT_TRUE(config != nullptr) << error_msg;
309   ASSERT_TRUE(error_msg.empty()) << error_msg;
310 }
311