Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2016 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 17 | #include "androidfw/ApkAssets.h" |
| 18 | |
Adam Lesinski | d1ecd7a | 2017-01-23 12:58:11 -0800 | [diff] [blame] | 19 | #include <algorithm> |
| 20 | |
Adam Lesinski | 970bd8d | 2017-09-25 13:21:55 -0700 | [diff] [blame] | 21 | #include "android-base/errors.h" |
| 22 | #include "android-base/file.h" |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 23 | #include "android-base/logging.h" |
Adam Lesinski | 970bd8d | 2017-09-25 13:21:55 -0700 | [diff] [blame] | 24 | #include "android-base/unique_fd.h" |
| 25 | #include "android-base/utf8.h" |
| 26 | #include "utils/Compat.h" |
Adam Lesinski | d1ecd7a | 2017-01-23 12:58:11 -0800 | [diff] [blame] | 27 | #include "utils/FileMap.h" |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 28 | #include "ziparchive/zip_archive.h" |
| 29 | |
| 30 | #include "androidfw/Asset.h" |
Adam Lesinski | 970bd8d | 2017-09-25 13:21:55 -0700 | [diff] [blame] | 31 | #include "androidfw/Idmap.h" |
| 32 | #include "androidfw/ResourceTypes.h" |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 33 | #include "androidfw/Util.h" |
| 34 | |
| 35 | namespace android { |
| 36 | |
Adam Lesinski | 970bd8d | 2017-09-25 13:21:55 -0700 | [diff] [blame] | 37 | using base::SystemErrorCodeToString; |
| 38 | using base::unique_fd; |
| 39 | |
| 40 | static const std::string kResourcesArsc("resources.arsc"); |
| 41 | |
Ryan Prichard | 3addcd3 | 2018-10-10 22:20:10 -0700 | [diff] [blame] | 42 | ApkAssets::ApkAssets(ZipArchiveHandle unmanaged_handle, const std::string& path) |
Adam Lesinski | 970bd8d | 2017-09-25 13:21:55 -0700 | [diff] [blame] | 43 | : zip_handle_(unmanaged_handle, ::CloseArchive), path_(path) { |
| 44 | } |
Adam Lesinski | 03ebac8 | 2017-09-25 13:10:14 -0700 | [diff] [blame] | 45 | |
Adam Lesinski | 0c40524 | 2017-01-13 20:47:26 -0800 | [diff] [blame] | 46 | std::unique_ptr<const ApkAssets> ApkAssets::Load(const std::string& path, bool system) { |
Adam Lesinski | 441500b | 2017-11-13 17:52:25 -0800 | [diff] [blame] | 47 | return LoadImpl({} /*fd*/, path, nullptr, nullptr, system, false /*load_as_shared_library*/); |
Adam Lesinski | da431a2 | 2016-12-29 16:08:16 -0500 | [diff] [blame] | 48 | } |
| 49 | |
Adam Lesinski | 0c40524 | 2017-01-13 20:47:26 -0800 | [diff] [blame] | 50 | std::unique_ptr<const ApkAssets> ApkAssets::LoadAsSharedLibrary(const std::string& path, |
| 51 | bool system) { |
Adam Lesinski | 441500b | 2017-11-13 17:52:25 -0800 | [diff] [blame] | 52 | return LoadImpl({} /*fd*/, path, nullptr, nullptr, system, true /*load_as_shared_library*/); |
Adam Lesinski | da431a2 | 2016-12-29 16:08:16 -0500 | [diff] [blame] | 53 | } |
| 54 | |
Adam Lesinski | 970bd8d | 2017-09-25 13:21:55 -0700 | [diff] [blame] | 55 | std::unique_ptr<const ApkAssets> ApkAssets::LoadOverlay(const std::string& idmap_path, |
| 56 | bool system) { |
| 57 | std::unique_ptr<Asset> idmap_asset = CreateAssetFromFile(idmap_path); |
| 58 | if (idmap_asset == nullptr) { |
| 59 | return {}; |
| 60 | } |
| 61 | |
| 62 | const StringPiece idmap_data( |
| 63 | reinterpret_cast<const char*>(idmap_asset->getBuffer(true /*wordAligned*/)), |
| 64 | static_cast<size_t>(idmap_asset->getLength())); |
| 65 | std::unique_ptr<const LoadedIdmap> loaded_idmap = LoadedIdmap::Load(idmap_data); |
| 66 | if (loaded_idmap == nullptr) { |
| 67 | LOG(ERROR) << "failed to load IDMAP " << idmap_path; |
| 68 | return {}; |
| 69 | } |
Adam Lesinski | 441500b | 2017-11-13 17:52:25 -0800 | [diff] [blame] | 70 | return LoadImpl({} /*fd*/, loaded_idmap->OverlayApkPath(), std::move(idmap_asset), |
| 71 | std::move(loaded_idmap), system, false /*load_as_shared_library*/); |
| 72 | } |
| 73 | |
| 74 | std::unique_ptr<const ApkAssets> ApkAssets::LoadFromFd(unique_fd fd, |
| 75 | const std::string& friendly_name, |
| 76 | bool system, bool force_shared_lib) { |
| 77 | return LoadImpl(std::move(fd), friendly_name, nullptr /*idmap_asset*/, nullptr /*loaded_idmap*/, |
| 78 | system, force_shared_lib); |
Adam Lesinski | 970bd8d | 2017-09-25 13:21:55 -0700 | [diff] [blame] | 79 | } |
| 80 | |
| 81 | std::unique_ptr<Asset> ApkAssets::CreateAssetFromFile(const std::string& path) { |
| 82 | unique_fd fd(base::utf8::open(path.c_str(), O_RDONLY | O_BINARY | O_CLOEXEC)); |
| 83 | if (fd == -1) { |
| 84 | LOG(ERROR) << "Failed to open file '" << path << "': " << SystemErrorCodeToString(errno); |
| 85 | return {}; |
| 86 | } |
| 87 | |
| 88 | const off64_t file_len = lseek64(fd, 0, SEEK_END); |
| 89 | if (file_len < 0) { |
| 90 | LOG(ERROR) << "Failed to get size of file '" << path << "': " << SystemErrorCodeToString(errno); |
| 91 | return {}; |
| 92 | } |
| 93 | |
| 94 | std::unique_ptr<FileMap> file_map = util::make_unique<FileMap>(); |
| 95 | if (!file_map->create(path.c_str(), fd, 0, static_cast<size_t>(file_len), true /*readOnly*/)) { |
| 96 | LOG(ERROR) << "Failed to mmap file '" << path << "': " << SystemErrorCodeToString(errno); |
| 97 | return {}; |
| 98 | } |
| 99 | return Asset::createFromUncompressedMap(std::move(file_map), Asset::AccessMode::ACCESS_RANDOM); |
| 100 | } |
| 101 | |
| 102 | std::unique_ptr<const ApkAssets> ApkAssets::LoadImpl( |
Adam Lesinski | 441500b | 2017-11-13 17:52:25 -0800 | [diff] [blame] | 103 | unique_fd fd, const std::string& path, std::unique_ptr<Asset> idmap_asset, |
Adam Lesinski | 970bd8d | 2017-09-25 13:21:55 -0700 | [diff] [blame] | 104 | std::unique_ptr<const LoadedIdmap> loaded_idmap, bool system, bool load_as_shared_library) { |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 105 | ::ZipArchiveHandle unmanaged_handle; |
Adam Lesinski | 441500b | 2017-11-13 17:52:25 -0800 | [diff] [blame] | 106 | int32_t result; |
| 107 | if (fd >= 0) { |
| 108 | result = |
| 109 | ::OpenArchiveFd(fd.release(), path.c_str(), &unmanaged_handle, true /*assume_ownership*/); |
| 110 | } else { |
| 111 | result = ::OpenArchive(path.c_str(), &unmanaged_handle); |
| 112 | } |
| 113 | |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 114 | if (result != 0) { |
Adam Lesinski | 970bd8d | 2017-09-25 13:21:55 -0700 | [diff] [blame] | 115 | LOG(ERROR) << "Failed to open APK '" << path << "' " << ::ErrorCodeString(result); |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 116 | return {}; |
| 117 | } |
| 118 | |
| 119 | // Wrap the handle in a unique_ptr so it gets automatically closed. |
Adam Lesinski | 970bd8d | 2017-09-25 13:21:55 -0700 | [diff] [blame] | 120 | std::unique_ptr<ApkAssets> loaded_apk(new ApkAssets(unmanaged_handle, path)); |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 121 | |
Adam Lesinski | 970bd8d | 2017-09-25 13:21:55 -0700 | [diff] [blame] | 122 | // Find the resource table. |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 123 | ::ZipEntry entry; |
Elliott Hughes | b97e737 | 2019-05-03 22:42:31 -0700 | [diff] [blame] | 124 | result = ::FindEntry(loaded_apk->zip_handle_.get(), kResourcesArsc, &entry); |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 125 | if (result != 0) { |
Adam Lesinski | 970bd8d | 2017-09-25 13:21:55 -0700 | [diff] [blame] | 126 | // There is no resources.arsc, so create an empty LoadedArsc and return. |
| 127 | loaded_apk->loaded_arsc_ = LoadedArsc::CreateEmpty(); |
| 128 | return std::move(loaded_apk); |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 129 | } |
| 130 | |
| 131 | if (entry.method == kCompressDeflated) { |
Adam Lesinski | 970bd8d | 2017-09-25 13:21:55 -0700 | [diff] [blame] | 132 | LOG(WARNING) << kResourcesArsc << " in APK '" << path << "' is compressed."; |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 133 | } |
| 134 | |
Adam Lesinski | 970bd8d | 2017-09-25 13:21:55 -0700 | [diff] [blame] | 135 | // Open the resource table via mmap unless it is compressed. This logic is taken care of by Open. |
| 136 | loaded_apk->resources_asset_ = loaded_apk->Open(kResourcesArsc, Asset::AccessMode::ACCESS_BUFFER); |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 137 | if (loaded_apk->resources_asset_ == nullptr) { |
Adam Lesinski | 970bd8d | 2017-09-25 13:21:55 -0700 | [diff] [blame] | 138 | LOG(ERROR) << "Failed to open '" << kResourcesArsc << "' in APK '" << path << "'."; |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 139 | return {}; |
| 140 | } |
| 141 | |
Adam Lesinski | 970bd8d | 2017-09-25 13:21:55 -0700 | [diff] [blame] | 142 | // Must retain ownership of the IDMAP Asset so that all pointers to its mmapped data remain valid. |
| 143 | loaded_apk->idmap_asset_ = std::move(idmap_asset); |
| 144 | |
| 145 | const StringPiece data( |
| 146 | reinterpret_cast<const char*>(loaded_apk->resources_asset_->getBuffer(true /*wordAligned*/)), |
| 147 | loaded_apk->resources_asset_->getLength()); |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 148 | loaded_apk->loaded_arsc_ = |
Adam Lesinski | 970bd8d | 2017-09-25 13:21:55 -0700 | [diff] [blame] | 149 | LoadedArsc::Load(data, loaded_idmap.get(), system, load_as_shared_library); |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 150 | if (loaded_apk->loaded_arsc_ == nullptr) { |
Adam Lesinski | 970bd8d | 2017-09-25 13:21:55 -0700 | [diff] [blame] | 151 | LOG(ERROR) << "Failed to load '" << kResourcesArsc << "' in APK '" << path << "'."; |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 152 | return {}; |
| 153 | } |
Adam Lesinski | 0c40524 | 2017-01-13 20:47:26 -0800 | [diff] [blame] | 154 | |
| 155 | // Need to force a move for mingw32. |
| 156 | return std::move(loaded_apk); |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 157 | } |
| 158 | |
Adam Lesinski | d1ecd7a | 2017-01-23 12:58:11 -0800 | [diff] [blame] | 159 | std::unique_ptr<Asset> ApkAssets::Open(const std::string& path, Asset::AccessMode mode) const { |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 160 | CHECK(zip_handle_ != nullptr); |
| 161 | |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 162 | ::ZipEntry entry; |
Elliott Hughes | b97e737 | 2019-05-03 22:42:31 -0700 | [diff] [blame] | 163 | int32_t result = ::FindEntry(zip_handle_.get(), path, &entry); |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 164 | if (result != 0) { |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 165 | return {}; |
| 166 | } |
| 167 | |
| 168 | if (entry.method == kCompressDeflated) { |
Adam Lesinski | d1ecd7a | 2017-01-23 12:58:11 -0800 | [diff] [blame] | 169 | std::unique_ptr<FileMap> map = util::make_unique<FileMap>(); |
| 170 | if (!map->create(path_.c_str(), ::GetFileDescriptor(zip_handle_.get()), entry.offset, |
| 171 | entry.compressed_length, true /*readOnly*/)) { |
| 172 | LOG(ERROR) << "Failed to mmap file '" << path << "' in APK '" << path_ << "'"; |
| 173 | return {}; |
| 174 | } |
| 175 | |
| 176 | std::unique_ptr<Asset> asset = |
| 177 | Asset::createFromCompressedMap(std::move(map), entry.uncompressed_length, mode); |
| 178 | if (asset == nullptr) { |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 179 | LOG(ERROR) << "Failed to decompress '" << path << "'."; |
| 180 | return {}; |
| 181 | } |
Adam Lesinski | d1ecd7a | 2017-01-23 12:58:11 -0800 | [diff] [blame] | 182 | return asset; |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 183 | } else { |
Adam Lesinski | d1ecd7a | 2017-01-23 12:58:11 -0800 | [diff] [blame] | 184 | std::unique_ptr<FileMap> map = util::make_unique<FileMap>(); |
| 185 | if (!map->create(path_.c_str(), ::GetFileDescriptor(zip_handle_.get()), entry.offset, |
| 186 | entry.uncompressed_length, true /*readOnly*/)) { |
| 187 | LOG(ERROR) << "Failed to mmap file '" << path << "' in APK '" << path_ << "'"; |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 188 | return {}; |
| 189 | } |
Adam Lesinski | d1ecd7a | 2017-01-23 12:58:11 -0800 | [diff] [blame] | 190 | |
| 191 | std::unique_ptr<Asset> asset = Asset::createFromUncompressedMap(std::move(map), mode); |
| 192 | if (asset == nullptr) { |
| 193 | LOG(ERROR) << "Failed to mmap file '" << path << "' in APK '" << path_ << "'"; |
| 194 | return {}; |
| 195 | } |
| 196 | return asset; |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 197 | } |
Adam Lesinski | d1ecd7a | 2017-01-23 12:58:11 -0800 | [diff] [blame] | 198 | } |
| 199 | |
| 200 | bool ApkAssets::ForEachFile(const std::string& root_path, |
| 201 | const std::function<void(const StringPiece&, FileType)>& f) const { |
| 202 | CHECK(zip_handle_ != nullptr); |
| 203 | |
| 204 | std::string root_path_full = root_path; |
| 205 | if (root_path_full.back() != '/') { |
| 206 | root_path_full += '/'; |
| 207 | } |
| 208 | |
Adam Lesinski | d1ecd7a | 2017-01-23 12:58:11 -0800 | [diff] [blame] | 209 | void* cookie; |
Elliott Hughes | 7a6cc0c | 2019-05-08 12:12:39 -0700 | [diff] [blame] | 210 | if (::StartIteration(zip_handle_.get(), &cookie, root_path_full, "") != 0) { |
Adam Lesinski | d1ecd7a | 2017-01-23 12:58:11 -0800 | [diff] [blame] | 211 | return false; |
| 212 | } |
| 213 | |
Elliott Hughes | a65cae9 | 2019-06-14 15:28:38 -0700 | [diff] [blame] | 214 | std::string name; |
Adam Lesinski | d1ecd7a | 2017-01-23 12:58:11 -0800 | [diff] [blame] | 215 | ::ZipEntry entry; |
| 216 | |
| 217 | // We need to hold back directories because many paths will contain them and we want to only |
| 218 | // surface one. |
| 219 | std::set<std::string> dirs; |
| 220 | |
| 221 | int32_t result; |
| 222 | while ((result = ::Next(cookie, &entry, &name)) == 0) { |
Elliott Hughes | a65cae9 | 2019-06-14 15:28:38 -0700 | [diff] [blame] | 223 | StringPiece full_file_path(name); |
Adam Lesinski | d1ecd7a | 2017-01-23 12:58:11 -0800 | [diff] [blame] | 224 | StringPiece leaf_file_path = full_file_path.substr(root_path_full.size()); |
Adam Lesinski | bebfcc4 | 2018-02-12 14:27:46 -0800 | [diff] [blame] | 225 | |
| 226 | if (!leaf_file_path.empty()) { |
| 227 | auto iter = std::find(leaf_file_path.begin(), leaf_file_path.end(), '/'); |
| 228 | if (iter != leaf_file_path.end()) { |
| 229 | std::string dir = |
| 230 | leaf_file_path.substr(0, std::distance(leaf_file_path.begin(), iter)).to_string(); |
| 231 | dirs.insert(std::move(dir)); |
| 232 | } else { |
| 233 | f(leaf_file_path, kFileTypeRegular); |
| 234 | } |
Adam Lesinski | d1ecd7a | 2017-01-23 12:58:11 -0800 | [diff] [blame] | 235 | } |
| 236 | } |
| 237 | ::EndIteration(cookie); |
| 238 | |
| 239 | // Now present the unique directories. |
| 240 | for (const std::string& dir : dirs) { |
| 241 | f(dir, kFileTypeDirectory); |
| 242 | } |
| 243 | |
| 244 | // -1 is end of iteration, anything else is an error. |
| 245 | return result == -1; |
Adam Lesinski | 7ad1110 | 2016-10-28 16:39:15 -0700 | [diff] [blame] | 246 | } |
| 247 | |
| 248 | } // namespace android |