blob: c798e31d641d03bf20efbde6b3fcbe72783669d9 [file] [log] [blame]
Doug Zongker76adfc52014-01-13 10:04:25 -08001/*
2 * Copyright (C) 2014 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
17// This program takes a file on an ext4 filesystem and produces a list
18// of the blocks that file occupies, which enables the file contents
19// to be read directly from the block device without mounting the
20// filesystem.
21//
22// If the filesystem is using an encrypted block device, it will also
23// read the file and rewrite it to the same blocks of the underlying
24// (unencrypted) block device, so the file contents can be read
25// without the need for the decryption key.
26//
27// The output of this program is a "block map" which looks like this:
28//
29// /dev/block/platform/msm_sdcc.1/by-name/userdata # block device
30// 49652 4096 # file size in bytes, block size
31// 3 # count of block ranges
32// 1000 1008 # block range 0
33// 2100 2102 # ... block range 1
34// 30 33 # ... block range 2
35//
36// Each block range represents a half-open interval; the line "30 33"
37// reprents the blocks [30, 31, 32].
38//
39// Recovery can take this block map file and retrieve the underlying
40// file data to use as an update package.
41
Tao Bao3a2bb592016-02-25 12:38:53 -080042/**
43 * In addition to the uncrypt work, uncrypt also takes care of setting and
44 * clearing the bootloader control block (BCB) at /misc partition.
45 *
46 * uncrypt is triggered as init services on demand. It uses socket to
47 * communicate with its caller (i.e. system_server). The socket is managed by
48 * init (i.e. created prior to the service starts, and destroyed when uncrypt
49 * exits).
50 *
51 * Below is the uncrypt protocol.
52 *
53 * a. caller b. init c. uncrypt
54 * --------------- ------------ --------------
55 * a1. ctl.start:
56 * setup-bcb /
57 * clear-bcb /
58 * uncrypt
59 *
60 * b2. create socket at
61 * /dev/socket/uncrypt
62 *
63 * c3. listen and accept
64 *
65 * a4. send a 4-byte int
66 * (message length)
67 * c5. receive message length
68 * a6. send message
69 * c7. receive message
70 * c8. <do the work; may send
71 * the progress>
72 * a9. <may handle progress>
73 * c10. <upon finishing>
74 * send "100" or "-1"
75 *
76 * a11. receive status code
77 * a12. send a 4-byte int to
78 * ack the receive of the
79 * final status code
80 * c13. receive and exit
81 *
82 * b14. destroy the socket
83 *
84 * Note that a12 and c13 are necessary to ensure a11 happens before the socket
85 * gets destroyed in b14.
86 */
87
88#include <arpa/inet.h>
Elliott Hughesd4d4c242014-12-29 12:46:43 -080089#include <errno.h>
Tao Bao75238632015-05-27 14:46:17 -070090#include <fcntl.h>
Tao Baob8df5fb2015-12-08 22:47:25 -080091#include <inttypes.h>
Tao Bao75238632015-05-27 14:46:17 -070092#include <linux/fs.h>
93#include <stdarg.h>
Doug Zongker76adfc52014-01-13 10:04:25 -080094#include <stdio.h>
95#include <stdlib.h>
Elliott Hughescd3c55a2015-01-29 20:50:08 -080096#include <string.h>
Doug Zongker76adfc52014-01-13 10:04:25 -080097#include <sys/mman.h>
Tao Bao3a2bb592016-02-25 12:38:53 -080098#include <sys/socket.h>
Tao Bao383b00d2015-05-21 16:44:44 -070099#include <sys/stat.h>
100#include <sys/types.h>
Tao Bao75238632015-05-27 14:46:17 -0700101#include <unistd.h>
Doug Zongker76adfc52014-01-13 10:04:25 -0800102
Yabin Cui25dd0382016-02-01 11:40:37 -0800103#include <algorithm>
Tao Baoc7547922015-08-06 18:35:05 -0700104#include <memory>
Tao Baod1670a02018-12-05 09:23:40 -0800105#include <string>
Yabin Cui25dd0382016-02-01 11:40:37 -0800106#include <vector>
Tao Baoc7547922015-08-06 18:35:05 -0700107
Elliott Hughes4b166f02015-12-04 15:30:20 -0800108#include <android-base/file.h>
Yabin Cui2d46da52016-01-26 16:50:15 -0800109#include <android-base/logging.h>
Elliott Hughes91e3aee2016-09-23 15:30:55 -0700110#include <android-base/properties.h>
Yabin Cui25dd0382016-02-01 11:40:37 -0800111#include <android-base/stringprintf.h>
Elliott Hughes4b166f02015-12-04 15:30:20 -0800112#include <android-base/strings.h>
Elliott Hughesbcabd092016-03-22 20:19:22 -0700113#include <android-base/unique_fd.h>
Yabin Cui2f272c02016-06-24 18:22:02 -0700114#include <bootloader_message/bootloader_message.h>
Tao Bao75238632015-05-27 14:46:17 -0700115#include <cutils/android_reboot.h>
Tao Bao3a2bb592016-02-25 12:38:53 -0800116#include <cutils/sockets.h>
Doug Zongker76adfc52014-01-13 10:04:25 -0800117#include <fs_mgr.h>
Tom Cherry772c93c2018-12-04 09:37:39 -0800118#include <fstab/fstab.h>
Doug Zongker76adfc52014-01-13 10:04:25 -0800119
Tao Bao1fc5bf32017-10-06 07:43:41 -0700120#include "otautil/error_code.h"
Tianjie Xuda44cf12016-09-24 15:31:34 -0700121
Tom Cherry72a114a2019-01-30 15:59:53 -0800122using android::fs_mgr::Fstab;
123using android::fs_mgr::ReadDefaultFstab;
124
Tianjie Xubc426032016-11-11 13:53:25 -0800125static constexpr int WINDOW_SIZE = 5;
126static constexpr int FIBMAP_RETRY_LIMIT = 3;
Tao Bao383b00d2015-05-21 16:44:44 -0700127
Tao Bao3a2bb592016-02-25 12:38:53 -0800128// uncrypt provides three services: SETUP_BCB, CLEAR_BCB and UNCRYPT.
129//
130// SETUP_BCB and CLEAR_BCB services use socket communication and do not rely
131// on /cache partitions. They will handle requests to reboot into recovery
132// (for applying updates for non-A/B devices, or factory resets for all
133// devices).
134//
135// UNCRYPT service still needs files on /cache partition (UNCRYPT_PATH_FILE
136// and CACHE_BLOCK_MAP). It will be working (and needed) only for non-A/B
137// devices, on which /cache partitions always exist.
Yabin Cui2d46da52016-01-26 16:50:15 -0800138static const std::string CACHE_BLOCK_MAP = "/cache/recovery/block.map";
Yabin Cui2d46da52016-01-26 16:50:15 -0800139static const std::string UNCRYPT_PATH_FILE = "/cache/recovery/uncrypt_file";
Tianjie Xue16e7992016-09-09 10:55:44 -0700140static const std::string UNCRYPT_STATUS = "/cache/recovery/uncrypt_status";
Tao Bao3a2bb592016-02-25 12:38:53 -0800141static const std::string UNCRYPT_SOCKET = "uncrypt";
Doug Zongker76adfc52014-01-13 10:04:25 -0800142
Tom Cherry772c93c2018-12-04 09:37:39 -0800143static Fstab fstab;
Doug Zongker2efc9d92014-08-18 15:55:28 -0700144
Tao Bao381f4552015-05-05 18:36:45 -0700145static int write_at_offset(unsigned char* buffer, size_t size, int wfd, off64_t offset) {
Elliott Hughes7bad7c42015-04-28 17:24:24 -0700146 if (TEMP_FAILURE_RETRY(lseek64(wfd, offset, SEEK_SET)) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700147 PLOG(ERROR) << "error seeking to offset " << offset;
Elliott Hughes7bad7c42015-04-28 17:24:24 -0700148 return -1;
149 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800150 if (!android::base::WriteFully(wfd, buffer, size)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700151 PLOG(ERROR) << "error writing offset " << offset;
Yabin Cui25dd0382016-02-01 11:40:37 -0800152 return -1;
Doug Zongker76adfc52014-01-13 10:04:25 -0800153 }
154 return 0;
155}
156
Yabin Cui25dd0382016-02-01 11:40:37 -0800157static void add_block_to_ranges(std::vector<int>& ranges, int new_block) {
158 if (!ranges.empty() && new_block == ranges.back()) {
Doug Zongker76adfc52014-01-13 10:04:25 -0800159 // If the new block comes immediately after the current range,
160 // all we have to do is extend the current range.
Yabin Cui25dd0382016-02-01 11:40:37 -0800161 ++ranges.back();
Doug Zongker76adfc52014-01-13 10:04:25 -0800162 } else {
163 // We need to start a new range.
Yabin Cui25dd0382016-02-01 11:40:37 -0800164 ranges.push_back(new_block);
165 ranges.push_back(new_block + 1);
Doug Zongker76adfc52014-01-13 10:04:25 -0800166 }
167}
168
Tao Baod1670a02018-12-05 09:23:40 -0800169// Looks for a volume whose mount point is the prefix of path and returns its block device or an
170// empty string. Sets encryption flags accordingly.
171static std::string FindBlockDevice(const std::string& path, bool* encryptable, bool* encrypted,
172 bool* f2fs_fs) {
173 // Ensure f2fs_fs is set to false first.
174 *f2fs_fs = false;
Jaegeuk Kimb6e6ee72017-12-08 13:19:23 -0800175
Tao Baod1670a02018-12-05 09:23:40 -0800176 for (const auto& entry : fstab) {
177 if (entry.mount_point.empty()) {
178 continue;
Doug Zongker76adfc52014-01-13 10:04:25 -0800179 }
Tao Baobb134b22018-12-05 14:33:28 -0800180 if (android::base::StartsWith(path, entry.mount_point + "/")) {
Tao Baod1670a02018-12-05 09:23:40 -0800181 *encrypted = false;
182 *encryptable = false;
183 if (entry.is_encryptable() || entry.fs_mgr_flags.file_encryption) {
184 *encryptable = true;
185 if (android::base::GetProperty("ro.crypto.state", "") == "encrypted") {
186 *encrypted = true;
187 }
188 }
189 if (entry.fs_type == "f2fs") {
190 *f2fs_fs = true;
191 }
192 return entry.blk_device;
193 }
194 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800195
Tao Baod1670a02018-12-05 09:23:40 -0800196 return "";
Doug Zongker76adfc52014-01-13 10:04:25 -0800197}
198
Tao Bao3a2bb592016-02-25 12:38:53 -0800199static bool write_status_to_socket(int status, int socket) {
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700200 // If socket equals -1, uncrypt is in debug mode without socket communication.
201 // Skip writing and return success.
202 if (socket == -1) {
203 return true;
204 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800205 int status_out = htonl(status);
206 return android::base::WriteFully(socket, &status_out, sizeof(int));
207}
208
Tao Baod1670a02018-12-05 09:23:40 -0800209// Parses the given path file to find the update package name.
210static bool FindUncryptPackage(const std::string& uncrypt_path_file, std::string* package_name) {
211 CHECK(package_name != nullptr);
212 std::string uncrypt_path;
213 if (!android::base::ReadFileToString(uncrypt_path_file, &uncrypt_path)) {
214 PLOG(ERROR) << "failed to open \"" << uncrypt_path_file << "\"";
215 return false;
216 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800217
Tao Baod1670a02018-12-05 09:23:40 -0800218 // Remove the trailing '\n' if present.
219 *package_name = android::base::Trim(uncrypt_path);
220 return true;
Doug Zongker76adfc52014-01-13 10:04:25 -0800221}
222
Tao Baod1670a02018-12-05 09:23:40 -0800223static int RetryFibmap(int fd, const std::string& name, int* block, const int head_block) {
224 CHECK(block != nullptr);
225 for (size_t i = 0; i < FIBMAP_RETRY_LIMIT; i++) {
226 if (fsync(fd) == -1) {
227 PLOG(ERROR) << "failed to fsync \"" << name << "\"";
228 return kUncryptFileSyncError;
Tianjie Xubc426032016-11-11 13:53:25 -0800229 }
Tao Baod1670a02018-12-05 09:23:40 -0800230 if (ioctl(fd, FIBMAP, block) != 0) {
231 PLOG(ERROR) << "failed to find block " << head_block;
232 return kUncryptIoctlError;
233 }
234 if (*block != 0) {
235 return kUncryptNoError;
236 }
237 sleep(1);
238 }
239 LOG(ERROR) << "fibmap of " << head_block << " always returns 0";
240 return kUncryptIoctlError;
Tianjie Xubc426032016-11-11 13:53:25 -0800241}
242
Tao Baod1670a02018-12-05 09:23:40 -0800243static int ProductBlockMap(const std::string& path, const std::string& map_file,
244 const std::string& blk_dev, bool encrypted, bool f2fs_fs, int socket) {
245 std::string err;
246 if (!android::base::RemoveFileIfExists(map_file, &err)) {
247 LOG(ERROR) << "failed to remove the existing map file " << map_file << ": " << err;
248 return kUncryptFileRemoveError;
249 }
250 std::string tmp_map_file = map_file + ".tmp";
251 android::base::unique_fd mapfd(open(tmp_map_file.c_str(), O_WRONLY | O_CREAT, S_IRUSR | S_IWUSR));
252 if (mapfd == -1) {
253 PLOG(ERROR) << "failed to open " << tmp_map_file;
254 return kUncryptFileOpenError;
255 }
256
257 // Make sure we can write to the socket.
258 if (!write_status_to_socket(0, socket)) {
259 LOG(ERROR) << "failed to write to socket " << socket;
260 return kUncryptSocketWriteError;
261 }
262
263 struct stat sb;
264 if (stat(path.c_str(), &sb) != 0) {
265 PLOG(ERROR) << "failed to stat " << path;
266 return kUncryptFileStatError;
267 }
268
269 LOG(INFO) << " block size: " << sb.st_blksize << " bytes";
270
271 int blocks = ((sb.st_size - 1) / sb.st_blksize) + 1;
272 LOG(INFO) << " file size: " << sb.st_size << " bytes, " << blocks << " blocks";
273
274 std::vector<int> ranges;
275
276 std::string s = android::base::StringPrintf("%s\n%" PRId64 " %" PRId64 "\n", blk_dev.c_str(),
277 static_cast<int64_t>(sb.st_size),
278 static_cast<int64_t>(sb.st_blksize));
279 if (!android::base::WriteStringToFd(s, mapfd)) {
280 PLOG(ERROR) << "failed to write " << tmp_map_file;
281 return kUncryptWriteError;
282 }
283
284 std::vector<std::vector<unsigned char>> buffers;
285 if (encrypted) {
286 buffers.resize(WINDOW_SIZE, std::vector<unsigned char>(sb.st_blksize));
287 }
288 int head_block = 0;
289 int head = 0, tail = 0;
290
291 android::base::unique_fd fd(open(path.c_str(), O_RDWR));
292 if (fd == -1) {
293 PLOG(ERROR) << "failed to open " << path << " for reading";
294 return kUncryptFileOpenError;
295 }
296
297 android::base::unique_fd wfd;
298 if (encrypted) {
299 wfd.reset(open(blk_dev.c_str(), O_WRONLY));
300 if (wfd == -1) {
301 PLOG(ERROR) << "failed to open " << blk_dev << " for writing";
302 return kUncryptBlockOpenError;
Sungmin Choia72512c2014-12-10 21:57:09 +0900303 }
Tao Baod1670a02018-12-05 09:23:40 -0800304 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800305
Jaegeuk Kimb6e6ee72017-12-08 13:19:23 -0800306// F2FS-specific ioctl
307// It requires the below kernel commit merged in v4.16-rc1.
308// 1ad71a27124c ("f2fs: add an ioctl to disable GC for specific file")
309// In android-4.4,
310// 56ee1e817908 ("f2fs: updates on v4.16-rc1")
311// In android-4.9,
312// 2f17e34672a8 ("f2fs: updates on v4.16-rc1")
313// In android-4.14,
314// ce767d9a55bc ("f2fs: updates on v4.16-rc1")
315#ifndef F2FS_IOC_SET_PIN_FILE
316#ifndef F2FS_IOCTL_MAGIC
317#define F2FS_IOCTL_MAGIC 0xf5
318#endif
319#define F2FS_IOC_SET_PIN_FILE _IOW(F2FS_IOCTL_MAGIC, 13, __u32)
Devin Kim29472c72018-09-12 08:42:49 -0700320#define F2FS_IOC_GET_PIN_FILE _IOR(F2FS_IOCTL_MAGIC, 14, __u32)
Jaegeuk Kimb6e6ee72017-12-08 13:19:23 -0800321#endif
322 if (f2fs_fs) {
Jaegeuk Kim2669da02018-07-23 15:38:35 -0700323 __u32 set = 1;
324 int error = ioctl(fd, F2FS_IOC_SET_PIN_FILE, &set);
Jaegeuk Kimb6e6ee72017-12-08 13:19:23 -0800325 // Don't break the old kernels which don't support it.
326 if (error && errno != ENOTTY && errno != ENOTSUP) {
327 PLOG(ERROR) << "Failed to set pin_file for f2fs: " << path << " on " << blk_dev;
328 return kUncryptIoctlError;
329 }
330 }
331
Tao Baob8df5fb2015-12-08 22:47:25 -0800332 off64_t pos = 0;
Tao Bao383b00d2015-05-21 16:44:44 -0700333 int last_progress = 0;
Doug Zongker76adfc52014-01-13 10:04:25 -0800334 while (pos < sb.st_size) {
Tao Bao383b00d2015-05-21 16:44:44 -0700335 // Update the status file, progress must be between [0, 99].
336 int progress = static_cast<int>(100 * (double(pos) / double(sb.st_size)));
337 if (progress > last_progress) {
Tao Bao3a2bb592016-02-25 12:38:53 -0800338 last_progress = progress;
339 write_status_to_socket(progress, socket);
Tao Bao383b00d2015-05-21 16:44:44 -0700340 }
341
Doug Zongker76adfc52014-01-13 10:04:25 -0800342 if ((tail+1) % WINDOW_SIZE == head) {
343 // write out head buffer
344 int block = head_block;
Elliott Hughesbcabd092016-03-22 20:19:22 -0700345 if (ioctl(fd, FIBMAP, &block) != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700346 PLOG(ERROR) << "failed to find block " << head_block;
347 return kUncryptIoctlError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800348 }
Tianjie Xubc426032016-11-11 13:53:25 -0800349
350 if (block == 0) {
351 LOG(ERROR) << "failed to find block " << head_block << ", retrying";
Tao Baod1670a02018-12-05 09:23:40 -0800352 int error = RetryFibmap(fd, path, &block, head_block);
Tianjie Xubc426032016-11-11 13:53:25 -0800353 if (error != kUncryptNoError) {
354 return error;
355 }
356 }
357
Yabin Cui25dd0382016-02-01 11:40:37 -0800358 add_block_to_ranges(ranges, block);
Doug Zongker76adfc52014-01-13 10:04:25 -0800359 if (encrypted) {
Elliott Hughesbcabd092016-03-22 20:19:22 -0700360 if (write_at_offset(buffers[head].data(), sb.st_blksize, wfd,
361 static_cast<off64_t>(sb.st_blksize) * block) != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700362 return kUncryptWriteError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800363 }
364 }
365 head = (head + 1) % WINDOW_SIZE;
366 ++head_block;
367 }
368
369 // read next block to tail
370 if (encrypted) {
Yabin Cui25dd0382016-02-01 11:40:37 -0800371 size_t to_read = static_cast<size_t>(
372 std::min(static_cast<off64_t>(sb.st_blksize), sb.st_size - pos));
Elliott Hughesbcabd092016-03-22 20:19:22 -0700373 if (!android::base::ReadFully(fd, buffers[tail].data(), to_read)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700374 PLOG(ERROR) << "failed to read " << path;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700375 return kUncryptReadError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800376 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800377 pos += to_read;
Doug Zongker76adfc52014-01-13 10:04:25 -0800378 } else {
379 // If we're not encrypting; we don't need to actually read
380 // anything, just skip pos forward as if we'd read a
381 // block.
382 pos += sb.st_blksize;
383 }
384 tail = (tail+1) % WINDOW_SIZE;
385 }
386
387 while (head != tail) {
388 // write out head buffer
389 int block = head_block;
Elliott Hughesbcabd092016-03-22 20:19:22 -0700390 if (ioctl(fd, FIBMAP, &block) != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700391 PLOG(ERROR) << "failed to find block " << head_block;
392 return kUncryptIoctlError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800393 }
Tianjie Xubc426032016-11-11 13:53:25 -0800394
395 if (block == 0) {
396 LOG(ERROR) << "failed to find block " << head_block << ", retrying";
Tao Baod1670a02018-12-05 09:23:40 -0800397 int error = RetryFibmap(fd, path, &block, head_block);
Tianjie Xubc426032016-11-11 13:53:25 -0800398 if (error != kUncryptNoError) {
399 return error;
400 }
401 }
402
Yabin Cui25dd0382016-02-01 11:40:37 -0800403 add_block_to_ranges(ranges, block);
Doug Zongker76adfc52014-01-13 10:04:25 -0800404 if (encrypted) {
Elliott Hughesbcabd092016-03-22 20:19:22 -0700405 if (write_at_offset(buffers[head].data(), sb.st_blksize, wfd,
406 static_cast<off64_t>(sb.st_blksize) * block) != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700407 return kUncryptWriteError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800408 }
409 }
410 head = (head + 1) % WINDOW_SIZE;
411 ++head_block;
412 }
413
Yabin Cui25dd0382016-02-01 11:40:37 -0800414 if (!android::base::WriteStringToFd(
Elliott Hughesbcabd092016-03-22 20:19:22 -0700415 android::base::StringPrintf("%zu\n", ranges.size() / 2), mapfd)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700416 PLOG(ERROR) << "failed to write " << tmp_map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700417 return kUncryptWriteError;
Tao Baofb4ccef2015-05-04 10:10:13 -0700418 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800419 for (size_t i = 0; i < ranges.size(); i += 2) {
420 if (!android::base::WriteStringToFd(
Elliott Hughesbcabd092016-03-22 20:19:22 -0700421 android::base::StringPrintf("%d %d\n", ranges[i], ranges[i+1]), mapfd)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700422 PLOG(ERROR) << "failed to write " << tmp_map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700423 return kUncryptWriteError;
Tao Baofb4ccef2015-05-04 10:10:13 -0700424 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800425 }
426
Elliott Hughesbcabd092016-03-22 20:19:22 -0700427 if (fsync(mapfd) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700428 PLOG(ERROR) << "failed to fsync \"" << tmp_map_file << "\"";
Tianjie Xuda44cf12016-09-24 15:31:34 -0700429 return kUncryptFileSyncError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800430 }
Elliott Hughesbcabd092016-03-22 20:19:22 -0700431 if (close(mapfd.release()) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700432 PLOG(ERROR) << "failed to close " << tmp_map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700433 return kUncryptFileCloseError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800434 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800435
436 if (encrypted) {
Elliott Hughesbcabd092016-03-22 20:19:22 -0700437 if (fsync(wfd) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700438 PLOG(ERROR) << "failed to fsync \"" << blk_dev << "\"";
Tianjie Xuda44cf12016-09-24 15:31:34 -0700439 return kUncryptFileSyncError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800440 }
Elliott Hughesbcabd092016-03-22 20:19:22 -0700441 if (close(wfd.release()) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700442 PLOG(ERROR) << "failed to close " << blk_dev;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700443 return kUncryptFileCloseError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800444 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800445 }
446
Tao Baod1670a02018-12-05 09:23:40 -0800447 if (rename(tmp_map_file.c_str(), map_file.c_str()) == -1) {
448 PLOG(ERROR) << "failed to rename " << tmp_map_file << " to " << map_file;
449 return kUncryptFileRenameError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800450 }
451 // Sync dir to make rename() result written to disk.
Tao Baod1670a02018-12-05 09:23:40 -0800452 std::string dir_name = android::base::Dirname(map_file);
Elliott Hughesbcabd092016-03-22 20:19:22 -0700453 android::base::unique_fd dfd(open(dir_name.c_str(), O_RDONLY | O_DIRECTORY));
454 if (dfd == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700455 PLOG(ERROR) << "failed to open dir " << dir_name;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700456 return kUncryptFileOpenError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800457 }
Elliott Hughesbcabd092016-03-22 20:19:22 -0700458 if (fsync(dfd) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700459 PLOG(ERROR) << "failed to fsync " << dir_name;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700460 return kUncryptFileSyncError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800461 }
Elliott Hughesbcabd092016-03-22 20:19:22 -0700462 if (close(dfd.release()) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700463 PLOG(ERROR) << "failed to close " << dir_name;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700464 return kUncryptFileCloseError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800465 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800466 return 0;
467}
468
Tao Baod1670a02018-12-05 09:23:40 -0800469static int Uncrypt(const std::string& input_path, const std::string& map_file, int socket) {
470 LOG(INFO) << "update package is \"" << input_path << "\"";
Doug Zongkerf449db22014-08-26 09:15:08 -0700471
Tao Baod1670a02018-12-05 09:23:40 -0800472 // Turn the name of the file we're supposed to convert into an absolute path, so we can find what
473 // filesystem it's on.
474 std::string path;
475 if (!android::base::Realpath(input_path, &path)) {
476 PLOG(ERROR) << "Failed to convert \"" << input_path << "\" to absolute path";
477 return kUncryptRealpathFindError;
478 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800479
Chih-Hung Hsieh5fce3a12020-04-23 14:26:21 -0700480 bool encryptable = false;
481 bool encrypted = false;
482 bool f2fs_fs = false;
Tao Baod1670a02018-12-05 09:23:40 -0800483 const std::string blk_dev = FindBlockDevice(path, &encryptable, &encrypted, &f2fs_fs);
484 if (blk_dev.empty()) {
485 LOG(ERROR) << "Failed to find block device for " << path;
486 return kUncryptBlockDeviceFindError;
487 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800488
Tao Baod1670a02018-12-05 09:23:40 -0800489 // If the filesystem it's on isn't encrypted, we only produce the block map, we don't rewrite the
490 // file contents (it would be pointless to do so).
491 LOG(INFO) << "encryptable: " << (encryptable ? "yes" : "no");
492 LOG(INFO) << " encrypted: " << (encrypted ? "yes" : "no");
Doug Zongker76adfc52014-01-13 10:04:25 -0800493
Tao Baod1670a02018-12-05 09:23:40 -0800494 // Recovery supports installing packages from 3 paths: /cache, /data, and /sdcard. (On a
495 // particular device, other locations may work, but those are three we actually expect.)
496 //
497 // On /data we want to convert the file to a block map so that we can read the package without
498 // mounting the partition. On /cache and /sdcard we leave the file alone.
499 if (android::base::StartsWith(path, "/data/")) {
500 LOG(INFO) << "writing block map " << map_file;
501 return ProductBlockMap(path, map_file, blk_dev, encrypted, f2fs_fs, socket);
502 }
Tao Bao383b00d2015-05-21 16:44:44 -0700503
Tao Baod1670a02018-12-05 09:23:40 -0800504 return 0;
Tao Bao383b00d2015-05-21 16:44:44 -0700505}
506
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700507static void log_uncrypt_error_code(UncryptErrorCode error_code) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700508 if (!android::base::WriteStringToFile(android::base::StringPrintf(
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700509 "uncrypt_error: %d\n", error_code), UNCRYPT_STATUS)) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700510 PLOG(WARNING) << "failed to write to " << UNCRYPT_STATUS;
511 }
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700512}
513
514static bool uncrypt_wrapper(const char* input_path, const char* map_file, const int socket) {
515 // Initialize the uncrypt error to kUncryptErrorPlaceholder.
516 log_uncrypt_error_code(kUncryptErrorPlaceholder);
Tianjie Xuda44cf12016-09-24 15:31:34 -0700517
Yabin Cui2d46da52016-01-26 16:50:15 -0800518 std::string package;
519 if (input_path == nullptr) {
Tao Baod1670a02018-12-05 09:23:40 -0800520 if (!FindUncryptPackage(UNCRYPT_PATH_FILE, &package)) {
521 write_status_to_socket(-1, socket);
522 // Overwrite the error message.
523 log_uncrypt_error_code(kUncryptPackageMissingError);
524 return false;
525 }
526 input_path = package.c_str();
Yabin Cui2d46da52016-01-26 16:50:15 -0800527 }
528 CHECK(map_file != nullptr);
Tianjie Xue16e7992016-09-09 10:55:44 -0700529
Tianjie Xue16e7992016-09-09 10:55:44 -0700530 auto start = std::chrono::system_clock::now();
Tao Baod1670a02018-12-05 09:23:40 -0800531 int status = Uncrypt(input_path, map_file, socket);
Tianjie Xuda44cf12016-09-24 15:31:34 -0700532 std::chrono::duration<double> duration = std::chrono::system_clock::now() - start;
533 int count = static_cast<int>(duration.count());
534
535 std::string uncrypt_message = android::base::StringPrintf("uncrypt_time: %d\n", count);
Yabin Cui2d46da52016-01-26 16:50:15 -0800536 if (status != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700537 // Log the time cost and error code if uncrypt fails.
538 uncrypt_message += android::base::StringPrintf("uncrypt_error: %d\n", status);
539 if (!android::base::WriteStringToFile(uncrypt_message, UNCRYPT_STATUS)) {
540 PLOG(WARNING) << "failed to write to " << UNCRYPT_STATUS;
541 }
542
Tao Bao3a2bb592016-02-25 12:38:53 -0800543 write_status_to_socket(-1, socket);
544 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800545 }
Tianjie Xue16e7992016-09-09 10:55:44 -0700546
Tianjie Xuda44cf12016-09-24 15:31:34 -0700547 if (!android::base::WriteStringToFile(uncrypt_message, UNCRYPT_STATUS)) {
Tianjie Xue16e7992016-09-09 10:55:44 -0700548 PLOG(WARNING) << "failed to write to " << UNCRYPT_STATUS;
549 }
550
Tao Bao3a2bb592016-02-25 12:38:53 -0800551 write_status_to_socket(100, socket);
Tianjie Xue16e7992016-09-09 10:55:44 -0700552
Tao Bao3a2bb592016-02-25 12:38:53 -0800553 return true;
Yabin Cui2d46da52016-01-26 16:50:15 -0800554}
555
Tao Bao3a2bb592016-02-25 12:38:53 -0800556static bool clear_bcb(const int socket) {
Yabin Cuia58a6db2016-04-06 15:52:18 -0700557 std::string err;
558 if (!clear_bootloader_message(&err)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700559 LOG(ERROR) << "failed to clear bootloader message: " << err;
Tao Bao3a2bb592016-02-25 12:38:53 -0800560 write_status_to_socket(-1, socket);
561 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800562 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800563 write_status_to_socket(100, socket);
564 return true;
Yabin Cui2d46da52016-01-26 16:50:15 -0800565}
566
Tao Bao3a2bb592016-02-25 12:38:53 -0800567static bool setup_bcb(const int socket) {
568 // c5. receive message length
569 int length;
570 if (!android::base::ReadFully(socket, &length, 4)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700571 PLOG(ERROR) << "failed to read the length";
Tao Bao3a2bb592016-02-25 12:38:53 -0800572 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800573 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800574 length = ntohl(length);
575
576 // c7. receive message
Yabin Cui2d46da52016-01-26 16:50:15 -0800577 std::string content;
Tao Bao3a2bb592016-02-25 12:38:53 -0800578 content.resize(length);
579 if (!android::base::ReadFully(socket, &content[0], length)) {
Tao Bao10334082016-12-12 17:10:20 -0800580 PLOG(ERROR) << "failed to read the message";
Tao Bao3a2bb592016-02-25 12:38:53 -0800581 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800582 }
Tianjie Xu74778142016-08-05 18:00:04 -0700583 LOG(INFO) << " received command: [" << content << "] (" << content.size() << ")";
Yabin Cui6faf0262016-06-09 14:09:39 -0700584 std::vector<std::string> options = android::base::Split(content, "\n");
585 std::string wipe_package;
586 for (auto& option : options) {
587 if (android::base::StartsWith(option, "--wipe_package=")) {
588 std::string path = option.substr(strlen("--wipe_package="));
589 if (!android::base::ReadFileToString(path, &wipe_package)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700590 PLOG(ERROR) << "failed to read " << path;
Yabin Cui6faf0262016-06-09 14:09:39 -0700591 return false;
592 }
593 option = android::base::StringPrintf("--wipe_package_size=%zu", wipe_package.size());
594 }
595 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800596
597 // c8. setup the bcb command
Yabin Cuia58a6db2016-04-06 15:52:18 -0700598 std::string err;
Yabin Cui6faf0262016-06-09 14:09:39 -0700599 if (!write_bootloader_message(options, &err)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700600 LOG(ERROR) << "failed to set bootloader message: " << err;
Tao Bao3a2bb592016-02-25 12:38:53 -0800601 write_status_to_socket(-1, socket);
602 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800603 }
Yabin Cui6faf0262016-06-09 14:09:39 -0700604 if (!wipe_package.empty() && !write_wipe_package(wipe_package, &err)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700605 PLOG(ERROR) << "failed to set wipe package: " << err;
Yabin Cui6faf0262016-06-09 14:09:39 -0700606 write_status_to_socket(-1, socket);
607 return false;
608 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800609 // c10. send "100" status
610 write_status_to_socket(100, socket);
611 return true;
Yabin Cui2d46da52016-01-26 16:50:15 -0800612}
613
Yabin Cui2d46da52016-01-26 16:50:15 -0800614static void usage(const char* exename) {
615 fprintf(stderr, "Usage of %s:\n", exename);
616 fprintf(stderr, "%s [<package_path> <map_file>] Uncrypt ota package.\n", exename);
Yabin Cui2d46da52016-01-26 16:50:15 -0800617 fprintf(stderr, "%s --clear-bcb Clear BCB data in misc partition.\n", exename);
618 fprintf(stderr, "%s --setup-bcb Setup BCB data by command file.\n", exename);
Yabin Cui2d46da52016-01-26 16:50:15 -0800619}
620
621int main(int argc, char** argv) {
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700622 enum { UNCRYPT, SETUP_BCB, CLEAR_BCB, UNCRYPT_DEBUG } action;
Tao Bao3a2bb592016-02-25 12:38:53 -0800623 const char* input_path = nullptr;
624 const char* map_file = CACHE_BLOCK_MAP.c_str();
625
626 if (argc == 2 && strcmp(argv[1], "--clear-bcb") == 0) {
627 action = CLEAR_BCB;
628 } else if (argc == 2 && strcmp(argv[1], "--setup-bcb") == 0) {
629 action = SETUP_BCB;
Tao Bao3a2bb592016-02-25 12:38:53 -0800630 } else if (argc == 1) {
631 action = UNCRYPT;
632 } else if (argc == 3) {
633 input_path = argv[1];
634 map_file = argv[2];
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700635 action = UNCRYPT_DEBUG;
Tao Bao3a2bb592016-02-25 12:38:53 -0800636 } else {
637 usage(argv[0]);
638 return 2;
Doug Zongker76adfc52014-01-13 10:04:25 -0800639 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800640
Tom Cherry772c93c2018-12-04 09:37:39 -0800641 if (!ReadDefaultFstab(&fstab)) {
642 LOG(ERROR) << "failed to read default fstab";
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700643 log_uncrypt_error_code(kUncryptFstabReadError);
Tao Bao3a2bb592016-02-25 12:38:53 -0800644 return 1;
645 }
646
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700647 if (action == UNCRYPT_DEBUG) {
Tianjie Xu74778142016-08-05 18:00:04 -0700648 LOG(INFO) << "uncrypt called in debug mode, skip socket communication";
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700649 bool success = uncrypt_wrapper(input_path, map_file, -1);
650 if (success) {
Tianjie Xu74778142016-08-05 18:00:04 -0700651 LOG(INFO) << "uncrypt succeeded";
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700652 } else{
Tianjie Xu74778142016-08-05 18:00:04 -0700653 LOG(INFO) << "uncrypt failed";
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700654 }
655 return success ? 0 : 1;
656 }
657
Tao Bao3a2bb592016-02-25 12:38:53 -0800658 // c3. The socket is created by init when starting the service. uncrypt
659 // will use the socket to communicate with its caller.
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700660 android::base::unique_fd service_socket(android_get_control_socket(UNCRYPT_SOCKET.c_str()));
661 if (service_socket == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700662 PLOG(ERROR) << "failed to open socket \"" << UNCRYPT_SOCKET << "\"";
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700663 log_uncrypt_error_code(kUncryptSocketOpenError);
Tao Bao3a2bb592016-02-25 12:38:53 -0800664 return 1;
665 }
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700666 fcntl(service_socket, F_SETFD, FD_CLOEXEC);
Tao Bao3a2bb592016-02-25 12:38:53 -0800667
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700668 if (listen(service_socket, 1) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700669 PLOG(ERROR) << "failed to listen on socket " << service_socket.get();
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700670 log_uncrypt_error_code(kUncryptSocketListenError);
Tao Bao3a2bb592016-02-25 12:38:53 -0800671 return 1;
672 }
673
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700674 android::base::unique_fd socket_fd(accept4(service_socket, nullptr, nullptr, SOCK_CLOEXEC));
675 if (socket_fd == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700676 PLOG(ERROR) << "failed to accept on socket " << service_socket.get();
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700677 log_uncrypt_error_code(kUncryptSocketAcceptError);
Tao Bao3a2bb592016-02-25 12:38:53 -0800678 return 1;
679 }
680
681 bool success = false;
682 switch (action) {
683 case UNCRYPT:
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700684 success = uncrypt_wrapper(input_path, map_file, socket_fd);
Tao Bao3a2bb592016-02-25 12:38:53 -0800685 break;
686 case SETUP_BCB:
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700687 success = setup_bcb(socket_fd);
Tao Bao3a2bb592016-02-25 12:38:53 -0800688 break;
689 case CLEAR_BCB:
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700690 success = clear_bcb(socket_fd);
Tao Bao3a2bb592016-02-25 12:38:53 -0800691 break;
692 default: // Should never happen.
Tianjie Xu74778142016-08-05 18:00:04 -0700693 LOG(ERROR) << "Invalid uncrypt action code: " << action;
Tao Bao3a2bb592016-02-25 12:38:53 -0800694 return 1;
695 }
696
697 // c13. Read a 4-byte code from the client before uncrypt exits. This is to
698 // ensure the client to receive the last status code before the socket gets
699 // destroyed.
700 int code;
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700701 if (android::base::ReadFully(socket_fd, &code, 4)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700702 LOG(INFO) << " received " << code << ", exiting now";
Tao Bao3a2bb592016-02-25 12:38:53 -0800703 } else {
Tianjie Xu74778142016-08-05 18:00:04 -0700704 PLOG(ERROR) << "failed to read the code";
Tao Bao3a2bb592016-02-25 12:38:53 -0800705 }
706 return success ? 0 : 1;
Doug Zongker76adfc52014-01-13 10:04:25 -0800707}