blob: 75595ac2c0276d00398e4a833750cdf9fa155d1c [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
Tianjie Xubc426032016-11-11 13:53:25 -0800122static constexpr int WINDOW_SIZE = 5;
123static constexpr int FIBMAP_RETRY_LIMIT = 3;
Tao Bao383b00d2015-05-21 16:44:44 -0700124
Tao Bao3a2bb592016-02-25 12:38:53 -0800125// uncrypt provides three services: SETUP_BCB, CLEAR_BCB and UNCRYPT.
126//
127// SETUP_BCB and CLEAR_BCB services use socket communication and do not rely
128// on /cache partitions. They will handle requests to reboot into recovery
129// (for applying updates for non-A/B devices, or factory resets for all
130// devices).
131//
132// UNCRYPT service still needs files on /cache partition (UNCRYPT_PATH_FILE
133// and CACHE_BLOCK_MAP). It will be working (and needed) only for non-A/B
134// devices, on which /cache partitions always exist.
Yabin Cui2d46da52016-01-26 16:50:15 -0800135static const std::string CACHE_BLOCK_MAP = "/cache/recovery/block.map";
Yabin Cui2d46da52016-01-26 16:50:15 -0800136static const std::string UNCRYPT_PATH_FILE = "/cache/recovery/uncrypt_file";
Tianjie Xue16e7992016-09-09 10:55:44 -0700137static const std::string UNCRYPT_STATUS = "/cache/recovery/uncrypt_status";
Tao Bao3a2bb592016-02-25 12:38:53 -0800138static const std::string UNCRYPT_SOCKET = "uncrypt";
Doug Zongker76adfc52014-01-13 10:04:25 -0800139
Tom Cherry772c93c2018-12-04 09:37:39 -0800140static Fstab fstab;
Doug Zongker2efc9d92014-08-18 15:55:28 -0700141
Tao Bao381f4552015-05-05 18:36:45 -0700142static int write_at_offset(unsigned char* buffer, size_t size, int wfd, off64_t offset) {
Elliott Hughes7bad7c42015-04-28 17:24:24 -0700143 if (TEMP_FAILURE_RETRY(lseek64(wfd, offset, SEEK_SET)) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700144 PLOG(ERROR) << "error seeking to offset " << offset;
Elliott Hughes7bad7c42015-04-28 17:24:24 -0700145 return -1;
146 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800147 if (!android::base::WriteFully(wfd, buffer, size)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700148 PLOG(ERROR) << "error writing offset " << offset;
Yabin Cui25dd0382016-02-01 11:40:37 -0800149 return -1;
Doug Zongker76adfc52014-01-13 10:04:25 -0800150 }
151 return 0;
152}
153
Yabin Cui25dd0382016-02-01 11:40:37 -0800154static void add_block_to_ranges(std::vector<int>& ranges, int new_block) {
155 if (!ranges.empty() && new_block == ranges.back()) {
Doug Zongker76adfc52014-01-13 10:04:25 -0800156 // If the new block comes immediately after the current range,
157 // all we have to do is extend the current range.
Yabin Cui25dd0382016-02-01 11:40:37 -0800158 ++ranges.back();
Doug Zongker76adfc52014-01-13 10:04:25 -0800159 } else {
160 // We need to start a new range.
Yabin Cui25dd0382016-02-01 11:40:37 -0800161 ranges.push_back(new_block);
162 ranges.push_back(new_block + 1);
Doug Zongker76adfc52014-01-13 10:04:25 -0800163 }
164}
165
Tao Baod1670a02018-12-05 09:23:40 -0800166// Looks for a volume whose mount point is the prefix of path and returns its block device or an
167// empty string. Sets encryption flags accordingly.
168static std::string FindBlockDevice(const std::string& path, bool* encryptable, bool* encrypted,
169 bool* f2fs_fs) {
170 // Ensure f2fs_fs is set to false first.
171 *f2fs_fs = false;
Jaegeuk Kimb6e6ee72017-12-08 13:19:23 -0800172
Tao Baod1670a02018-12-05 09:23:40 -0800173 for (const auto& entry : fstab) {
174 if (entry.mount_point.empty()) {
175 continue;
Doug Zongker76adfc52014-01-13 10:04:25 -0800176 }
Tao Baobb134b22018-12-05 14:33:28 -0800177 if (android::base::StartsWith(path, entry.mount_point + "/")) {
Tao Baod1670a02018-12-05 09:23:40 -0800178 *encrypted = false;
179 *encryptable = false;
180 if (entry.is_encryptable() || entry.fs_mgr_flags.file_encryption) {
181 *encryptable = true;
182 if (android::base::GetProperty("ro.crypto.state", "") == "encrypted") {
183 *encrypted = true;
184 }
185 }
186 if (entry.fs_type == "f2fs") {
187 *f2fs_fs = true;
188 }
189 return entry.blk_device;
190 }
191 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800192
Tao Baod1670a02018-12-05 09:23:40 -0800193 return "";
Doug Zongker76adfc52014-01-13 10:04:25 -0800194}
195
Tao Bao3a2bb592016-02-25 12:38:53 -0800196static bool write_status_to_socket(int status, int socket) {
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700197 // If socket equals -1, uncrypt is in debug mode without socket communication.
198 // Skip writing and return success.
199 if (socket == -1) {
200 return true;
201 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800202 int status_out = htonl(status);
203 return android::base::WriteFully(socket, &status_out, sizeof(int));
204}
205
Tao Baod1670a02018-12-05 09:23:40 -0800206// Parses the given path file to find the update package name.
207static bool FindUncryptPackage(const std::string& uncrypt_path_file, std::string* package_name) {
208 CHECK(package_name != nullptr);
209 std::string uncrypt_path;
210 if (!android::base::ReadFileToString(uncrypt_path_file, &uncrypt_path)) {
211 PLOG(ERROR) << "failed to open \"" << uncrypt_path_file << "\"";
212 return false;
213 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800214
Tao Baod1670a02018-12-05 09:23:40 -0800215 // Remove the trailing '\n' if present.
216 *package_name = android::base::Trim(uncrypt_path);
217 return true;
Doug Zongker76adfc52014-01-13 10:04:25 -0800218}
219
Tao Baod1670a02018-12-05 09:23:40 -0800220static int RetryFibmap(int fd, const std::string& name, int* block, const int head_block) {
221 CHECK(block != nullptr);
222 for (size_t i = 0; i < FIBMAP_RETRY_LIMIT; i++) {
223 if (fsync(fd) == -1) {
224 PLOG(ERROR) << "failed to fsync \"" << name << "\"";
225 return kUncryptFileSyncError;
Tianjie Xubc426032016-11-11 13:53:25 -0800226 }
Tao Baod1670a02018-12-05 09:23:40 -0800227 if (ioctl(fd, FIBMAP, block) != 0) {
228 PLOG(ERROR) << "failed to find block " << head_block;
229 return kUncryptIoctlError;
230 }
231 if (*block != 0) {
232 return kUncryptNoError;
233 }
234 sleep(1);
235 }
236 LOG(ERROR) << "fibmap of " << head_block << " always returns 0";
237 return kUncryptIoctlError;
Tianjie Xubc426032016-11-11 13:53:25 -0800238}
239
Tao Baod1670a02018-12-05 09:23:40 -0800240static int ProductBlockMap(const std::string& path, const std::string& map_file,
241 const std::string& blk_dev, bool encrypted, bool f2fs_fs, int socket) {
242 std::string err;
243 if (!android::base::RemoveFileIfExists(map_file, &err)) {
244 LOG(ERROR) << "failed to remove the existing map file " << map_file << ": " << err;
245 return kUncryptFileRemoveError;
246 }
247 std::string tmp_map_file = map_file + ".tmp";
248 android::base::unique_fd mapfd(open(tmp_map_file.c_str(), O_WRONLY | O_CREAT, S_IRUSR | S_IWUSR));
249 if (mapfd == -1) {
250 PLOG(ERROR) << "failed to open " << tmp_map_file;
251 return kUncryptFileOpenError;
252 }
253
254 // Make sure we can write to the socket.
255 if (!write_status_to_socket(0, socket)) {
256 LOG(ERROR) << "failed to write to socket " << socket;
257 return kUncryptSocketWriteError;
258 }
259
260 struct stat sb;
261 if (stat(path.c_str(), &sb) != 0) {
262 PLOG(ERROR) << "failed to stat " << path;
263 return kUncryptFileStatError;
264 }
265
266 LOG(INFO) << " block size: " << sb.st_blksize << " bytes";
267
268 int blocks = ((sb.st_size - 1) / sb.st_blksize) + 1;
269 LOG(INFO) << " file size: " << sb.st_size << " bytes, " << blocks << " blocks";
270
271 std::vector<int> ranges;
272
273 std::string s = android::base::StringPrintf("%s\n%" PRId64 " %" PRId64 "\n", blk_dev.c_str(),
274 static_cast<int64_t>(sb.st_size),
275 static_cast<int64_t>(sb.st_blksize));
276 if (!android::base::WriteStringToFd(s, mapfd)) {
277 PLOG(ERROR) << "failed to write " << tmp_map_file;
278 return kUncryptWriteError;
279 }
280
281 std::vector<std::vector<unsigned char>> buffers;
282 if (encrypted) {
283 buffers.resize(WINDOW_SIZE, std::vector<unsigned char>(sb.st_blksize));
284 }
285 int head_block = 0;
286 int head = 0, tail = 0;
287
288 android::base::unique_fd fd(open(path.c_str(), O_RDWR));
289 if (fd == -1) {
290 PLOG(ERROR) << "failed to open " << path << " for reading";
291 return kUncryptFileOpenError;
292 }
293
294 android::base::unique_fd wfd;
295 if (encrypted) {
296 wfd.reset(open(blk_dev.c_str(), O_WRONLY));
297 if (wfd == -1) {
298 PLOG(ERROR) << "failed to open " << blk_dev << " for writing";
299 return kUncryptBlockOpenError;
Sungmin Choia72512c2014-12-10 21:57:09 +0900300 }
Tao Baod1670a02018-12-05 09:23:40 -0800301 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800302
Jaegeuk Kimb6e6ee72017-12-08 13:19:23 -0800303// F2FS-specific ioctl
304// It requires the below kernel commit merged in v4.16-rc1.
305// 1ad71a27124c ("f2fs: add an ioctl to disable GC for specific file")
306// In android-4.4,
307// 56ee1e817908 ("f2fs: updates on v4.16-rc1")
308// In android-4.9,
309// 2f17e34672a8 ("f2fs: updates on v4.16-rc1")
310// In android-4.14,
311// ce767d9a55bc ("f2fs: updates on v4.16-rc1")
312#ifndef F2FS_IOC_SET_PIN_FILE
313#ifndef F2FS_IOCTL_MAGIC
314#define F2FS_IOCTL_MAGIC 0xf5
315#endif
316#define F2FS_IOC_SET_PIN_FILE _IOW(F2FS_IOCTL_MAGIC, 13, __u32)
Devin Kim29472c72018-09-12 08:42:49 -0700317#define F2FS_IOC_GET_PIN_FILE _IOR(F2FS_IOCTL_MAGIC, 14, __u32)
Jaegeuk Kimb6e6ee72017-12-08 13:19:23 -0800318#endif
319 if (f2fs_fs) {
Jaegeuk Kim2669da02018-07-23 15:38:35 -0700320 __u32 set = 1;
321 int error = ioctl(fd, F2FS_IOC_SET_PIN_FILE, &set);
Jaegeuk Kimb6e6ee72017-12-08 13:19:23 -0800322 // Don't break the old kernels which don't support it.
323 if (error && errno != ENOTTY && errno != ENOTSUP) {
324 PLOG(ERROR) << "Failed to set pin_file for f2fs: " << path << " on " << blk_dev;
325 return kUncryptIoctlError;
326 }
327 }
328
Tao Baob8df5fb2015-12-08 22:47:25 -0800329 off64_t pos = 0;
Tao Bao383b00d2015-05-21 16:44:44 -0700330 int last_progress = 0;
Doug Zongker76adfc52014-01-13 10:04:25 -0800331 while (pos < sb.st_size) {
Tao Bao383b00d2015-05-21 16:44:44 -0700332 // Update the status file, progress must be between [0, 99].
333 int progress = static_cast<int>(100 * (double(pos) / double(sb.st_size)));
334 if (progress > last_progress) {
Tao Bao3a2bb592016-02-25 12:38:53 -0800335 last_progress = progress;
336 write_status_to_socket(progress, socket);
Tao Bao383b00d2015-05-21 16:44:44 -0700337 }
338
Doug Zongker76adfc52014-01-13 10:04:25 -0800339 if ((tail+1) % WINDOW_SIZE == head) {
340 // write out head buffer
341 int block = head_block;
Elliott Hughesbcabd092016-03-22 20:19:22 -0700342 if (ioctl(fd, FIBMAP, &block) != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700343 PLOG(ERROR) << "failed to find block " << head_block;
344 return kUncryptIoctlError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800345 }
Tianjie Xubc426032016-11-11 13:53:25 -0800346
347 if (block == 0) {
348 LOG(ERROR) << "failed to find block " << head_block << ", retrying";
Tao Baod1670a02018-12-05 09:23:40 -0800349 int error = RetryFibmap(fd, path, &block, head_block);
Tianjie Xubc426032016-11-11 13:53:25 -0800350 if (error != kUncryptNoError) {
351 return error;
352 }
353 }
354
Yabin Cui25dd0382016-02-01 11:40:37 -0800355 add_block_to_ranges(ranges, block);
Doug Zongker76adfc52014-01-13 10:04:25 -0800356 if (encrypted) {
Elliott Hughesbcabd092016-03-22 20:19:22 -0700357 if (write_at_offset(buffers[head].data(), sb.st_blksize, wfd,
358 static_cast<off64_t>(sb.st_blksize) * block) != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700359 return kUncryptWriteError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800360 }
361 }
362 head = (head + 1) % WINDOW_SIZE;
363 ++head_block;
364 }
365
366 // read next block to tail
367 if (encrypted) {
Yabin Cui25dd0382016-02-01 11:40:37 -0800368 size_t to_read = static_cast<size_t>(
369 std::min(static_cast<off64_t>(sb.st_blksize), sb.st_size - pos));
Elliott Hughesbcabd092016-03-22 20:19:22 -0700370 if (!android::base::ReadFully(fd, buffers[tail].data(), to_read)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700371 PLOG(ERROR) << "failed to read " << path;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700372 return kUncryptReadError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800373 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800374 pos += to_read;
Doug Zongker76adfc52014-01-13 10:04:25 -0800375 } else {
376 // If we're not encrypting; we don't need to actually read
377 // anything, just skip pos forward as if we'd read a
378 // block.
379 pos += sb.st_blksize;
380 }
381 tail = (tail+1) % WINDOW_SIZE;
382 }
383
384 while (head != tail) {
385 // write out head buffer
386 int block = head_block;
Elliott Hughesbcabd092016-03-22 20:19:22 -0700387 if (ioctl(fd, FIBMAP, &block) != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700388 PLOG(ERROR) << "failed to find block " << head_block;
389 return kUncryptIoctlError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800390 }
Tianjie Xubc426032016-11-11 13:53:25 -0800391
392 if (block == 0) {
393 LOG(ERROR) << "failed to find block " << head_block << ", retrying";
Tao Baod1670a02018-12-05 09:23:40 -0800394 int error = RetryFibmap(fd, path, &block, head_block);
Tianjie Xubc426032016-11-11 13:53:25 -0800395 if (error != kUncryptNoError) {
396 return error;
397 }
398 }
399
Yabin Cui25dd0382016-02-01 11:40:37 -0800400 add_block_to_ranges(ranges, block);
Doug Zongker76adfc52014-01-13 10:04:25 -0800401 if (encrypted) {
Elliott Hughesbcabd092016-03-22 20:19:22 -0700402 if (write_at_offset(buffers[head].data(), sb.st_blksize, wfd,
403 static_cast<off64_t>(sb.st_blksize) * block) != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700404 return kUncryptWriteError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800405 }
406 }
407 head = (head + 1) % WINDOW_SIZE;
408 ++head_block;
409 }
410
Yabin Cui25dd0382016-02-01 11:40:37 -0800411 if (!android::base::WriteStringToFd(
Elliott Hughesbcabd092016-03-22 20:19:22 -0700412 android::base::StringPrintf("%zu\n", ranges.size() / 2), mapfd)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700413 PLOG(ERROR) << "failed to write " << tmp_map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700414 return kUncryptWriteError;
Tao Baofb4ccef2015-05-04 10:10:13 -0700415 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800416 for (size_t i = 0; i < ranges.size(); i += 2) {
417 if (!android::base::WriteStringToFd(
Elliott Hughesbcabd092016-03-22 20:19:22 -0700418 android::base::StringPrintf("%d %d\n", ranges[i], ranges[i+1]), mapfd)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700419 PLOG(ERROR) << "failed to write " << tmp_map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700420 return kUncryptWriteError;
Tao Baofb4ccef2015-05-04 10:10:13 -0700421 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800422 }
423
Elliott Hughesbcabd092016-03-22 20:19:22 -0700424 if (fsync(mapfd) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700425 PLOG(ERROR) << "failed to fsync \"" << tmp_map_file << "\"";
Tianjie Xuda44cf12016-09-24 15:31:34 -0700426 return kUncryptFileSyncError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800427 }
Elliott Hughesbcabd092016-03-22 20:19:22 -0700428 if (close(mapfd.release()) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700429 PLOG(ERROR) << "failed to close " << tmp_map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700430 return kUncryptFileCloseError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800431 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800432
433 if (encrypted) {
Elliott Hughesbcabd092016-03-22 20:19:22 -0700434 if (fsync(wfd) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700435 PLOG(ERROR) << "failed to fsync \"" << blk_dev << "\"";
Tianjie Xuda44cf12016-09-24 15:31:34 -0700436 return kUncryptFileSyncError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800437 }
Elliott Hughesbcabd092016-03-22 20:19:22 -0700438 if (close(wfd.release()) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700439 PLOG(ERROR) << "failed to close " << blk_dev;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700440 return kUncryptFileCloseError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800441 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800442 }
443
Tao Baod1670a02018-12-05 09:23:40 -0800444 if (rename(tmp_map_file.c_str(), map_file.c_str()) == -1) {
445 PLOG(ERROR) << "failed to rename " << tmp_map_file << " to " << map_file;
446 return kUncryptFileRenameError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800447 }
448 // Sync dir to make rename() result written to disk.
Tao Baod1670a02018-12-05 09:23:40 -0800449 std::string dir_name = android::base::Dirname(map_file);
Elliott Hughesbcabd092016-03-22 20:19:22 -0700450 android::base::unique_fd dfd(open(dir_name.c_str(), O_RDONLY | O_DIRECTORY));
451 if (dfd == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700452 PLOG(ERROR) << "failed to open dir " << dir_name;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700453 return kUncryptFileOpenError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800454 }
Elliott Hughesbcabd092016-03-22 20:19:22 -0700455 if (fsync(dfd) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700456 PLOG(ERROR) << "failed to fsync " << dir_name;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700457 return kUncryptFileSyncError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800458 }
Elliott Hughesbcabd092016-03-22 20:19:22 -0700459 if (close(dfd.release()) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700460 PLOG(ERROR) << "failed to close " << dir_name;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700461 return kUncryptFileCloseError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800462 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800463 return 0;
464}
465
Tao Baod1670a02018-12-05 09:23:40 -0800466static int Uncrypt(const std::string& input_path, const std::string& map_file, int socket) {
467 LOG(INFO) << "update package is \"" << input_path << "\"";
Doug Zongkerf449db22014-08-26 09:15:08 -0700468
Tao Baod1670a02018-12-05 09:23:40 -0800469 // Turn the name of the file we're supposed to convert into an absolute path, so we can find what
470 // filesystem it's on.
471 std::string path;
472 if (!android::base::Realpath(input_path, &path)) {
473 PLOG(ERROR) << "Failed to convert \"" << input_path << "\" to absolute path";
474 return kUncryptRealpathFindError;
475 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800476
Tao Baod1670a02018-12-05 09:23:40 -0800477 bool encryptable;
478 bool encrypted;
479 bool f2fs_fs;
480 const std::string blk_dev = FindBlockDevice(path, &encryptable, &encrypted, &f2fs_fs);
481 if (blk_dev.empty()) {
482 LOG(ERROR) << "Failed to find block device for " << path;
483 return kUncryptBlockDeviceFindError;
484 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800485
Tao Baod1670a02018-12-05 09:23:40 -0800486 // If the filesystem it's on isn't encrypted, we only produce the block map, we don't rewrite the
487 // file contents (it would be pointless to do so).
488 LOG(INFO) << "encryptable: " << (encryptable ? "yes" : "no");
489 LOG(INFO) << " encrypted: " << (encrypted ? "yes" : "no");
Doug Zongker76adfc52014-01-13 10:04:25 -0800490
Tao Baod1670a02018-12-05 09:23:40 -0800491 // Recovery supports installing packages from 3 paths: /cache, /data, and /sdcard. (On a
492 // particular device, other locations may work, but those are three we actually expect.)
493 //
494 // On /data we want to convert the file to a block map so that we can read the package without
495 // mounting the partition. On /cache and /sdcard we leave the file alone.
496 if (android::base::StartsWith(path, "/data/")) {
497 LOG(INFO) << "writing block map " << map_file;
498 return ProductBlockMap(path, map_file, blk_dev, encrypted, f2fs_fs, socket);
499 }
Tao Bao383b00d2015-05-21 16:44:44 -0700500
Tao Baod1670a02018-12-05 09:23:40 -0800501 return 0;
Tao Bao383b00d2015-05-21 16:44:44 -0700502}
503
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700504static void log_uncrypt_error_code(UncryptErrorCode error_code) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700505 if (!android::base::WriteStringToFile(android::base::StringPrintf(
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700506 "uncrypt_error: %d\n", error_code), UNCRYPT_STATUS)) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700507 PLOG(WARNING) << "failed to write to " << UNCRYPT_STATUS;
508 }
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700509}
510
511static bool uncrypt_wrapper(const char* input_path, const char* map_file, const int socket) {
512 // Initialize the uncrypt error to kUncryptErrorPlaceholder.
513 log_uncrypt_error_code(kUncryptErrorPlaceholder);
Tianjie Xuda44cf12016-09-24 15:31:34 -0700514
Yabin Cui2d46da52016-01-26 16:50:15 -0800515 std::string package;
516 if (input_path == nullptr) {
Tao Baod1670a02018-12-05 09:23:40 -0800517 if (!FindUncryptPackage(UNCRYPT_PATH_FILE, &package)) {
518 write_status_to_socket(-1, socket);
519 // Overwrite the error message.
520 log_uncrypt_error_code(kUncryptPackageMissingError);
521 return false;
522 }
523 input_path = package.c_str();
Yabin Cui2d46da52016-01-26 16:50:15 -0800524 }
525 CHECK(map_file != nullptr);
Tianjie Xue16e7992016-09-09 10:55:44 -0700526
Tianjie Xue16e7992016-09-09 10:55:44 -0700527 auto start = std::chrono::system_clock::now();
Tao Baod1670a02018-12-05 09:23:40 -0800528 int status = Uncrypt(input_path, map_file, socket);
Tianjie Xuda44cf12016-09-24 15:31:34 -0700529 std::chrono::duration<double> duration = std::chrono::system_clock::now() - start;
530 int count = static_cast<int>(duration.count());
531
532 std::string uncrypt_message = android::base::StringPrintf("uncrypt_time: %d\n", count);
Yabin Cui2d46da52016-01-26 16:50:15 -0800533 if (status != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700534 // Log the time cost and error code if uncrypt fails.
535 uncrypt_message += android::base::StringPrintf("uncrypt_error: %d\n", status);
536 if (!android::base::WriteStringToFile(uncrypt_message, UNCRYPT_STATUS)) {
537 PLOG(WARNING) << "failed to write to " << UNCRYPT_STATUS;
538 }
539
Tao Bao3a2bb592016-02-25 12:38:53 -0800540 write_status_to_socket(-1, socket);
541 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800542 }
Tianjie Xue16e7992016-09-09 10:55:44 -0700543
Tianjie Xuda44cf12016-09-24 15:31:34 -0700544 if (!android::base::WriteStringToFile(uncrypt_message, UNCRYPT_STATUS)) {
Tianjie Xue16e7992016-09-09 10:55:44 -0700545 PLOG(WARNING) << "failed to write to " << UNCRYPT_STATUS;
546 }
547
Tao Bao3a2bb592016-02-25 12:38:53 -0800548 write_status_to_socket(100, socket);
Tianjie Xue16e7992016-09-09 10:55:44 -0700549
Tao Bao3a2bb592016-02-25 12:38:53 -0800550 return true;
Yabin Cui2d46da52016-01-26 16:50:15 -0800551}
552
Tao Bao3a2bb592016-02-25 12:38:53 -0800553static bool clear_bcb(const int socket) {
Yabin Cuia58a6db2016-04-06 15:52:18 -0700554 std::string err;
555 if (!clear_bootloader_message(&err)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700556 LOG(ERROR) << "failed to clear bootloader message: " << err;
Tao Bao3a2bb592016-02-25 12:38:53 -0800557 write_status_to_socket(-1, socket);
558 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800559 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800560 write_status_to_socket(100, socket);
561 return true;
Yabin Cui2d46da52016-01-26 16:50:15 -0800562}
563
Tao Bao3a2bb592016-02-25 12:38:53 -0800564static bool setup_bcb(const int socket) {
565 // c5. receive message length
566 int length;
567 if (!android::base::ReadFully(socket, &length, 4)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700568 PLOG(ERROR) << "failed to read the length";
Tao Bao3a2bb592016-02-25 12:38:53 -0800569 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800570 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800571 length = ntohl(length);
572
573 // c7. receive message
Yabin Cui2d46da52016-01-26 16:50:15 -0800574 std::string content;
Tao Bao3a2bb592016-02-25 12:38:53 -0800575 content.resize(length);
576 if (!android::base::ReadFully(socket, &content[0], length)) {
Tao Bao10334082016-12-12 17:10:20 -0800577 PLOG(ERROR) << "failed to read the message";
Tao Bao3a2bb592016-02-25 12:38:53 -0800578 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800579 }
Tianjie Xu74778142016-08-05 18:00:04 -0700580 LOG(INFO) << " received command: [" << content << "] (" << content.size() << ")";
Yabin Cui6faf0262016-06-09 14:09:39 -0700581 std::vector<std::string> options = android::base::Split(content, "\n");
582 std::string wipe_package;
583 for (auto& option : options) {
584 if (android::base::StartsWith(option, "--wipe_package=")) {
585 std::string path = option.substr(strlen("--wipe_package="));
586 if (!android::base::ReadFileToString(path, &wipe_package)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700587 PLOG(ERROR) << "failed to read " << path;
Yabin Cui6faf0262016-06-09 14:09:39 -0700588 return false;
589 }
590 option = android::base::StringPrintf("--wipe_package_size=%zu", wipe_package.size());
591 }
592 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800593
594 // c8. setup the bcb command
Yabin Cuia58a6db2016-04-06 15:52:18 -0700595 std::string err;
Yabin Cui6faf0262016-06-09 14:09:39 -0700596 if (!write_bootloader_message(options, &err)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700597 LOG(ERROR) << "failed to set bootloader message: " << err;
Tao Bao3a2bb592016-02-25 12:38:53 -0800598 write_status_to_socket(-1, socket);
599 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800600 }
Yabin Cui6faf0262016-06-09 14:09:39 -0700601 if (!wipe_package.empty() && !write_wipe_package(wipe_package, &err)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700602 PLOG(ERROR) << "failed to set wipe package: " << err;
Yabin Cui6faf0262016-06-09 14:09:39 -0700603 write_status_to_socket(-1, socket);
604 return false;
605 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800606 // c10. send "100" status
607 write_status_to_socket(100, socket);
608 return true;
Yabin Cui2d46da52016-01-26 16:50:15 -0800609}
610
Yabin Cui2d46da52016-01-26 16:50:15 -0800611static void usage(const char* exename) {
612 fprintf(stderr, "Usage of %s:\n", exename);
613 fprintf(stderr, "%s [<package_path> <map_file>] Uncrypt ota package.\n", exename);
Yabin Cui2d46da52016-01-26 16:50:15 -0800614 fprintf(stderr, "%s --clear-bcb Clear BCB data in misc partition.\n", exename);
615 fprintf(stderr, "%s --setup-bcb Setup BCB data by command file.\n", exename);
Yabin Cui2d46da52016-01-26 16:50:15 -0800616}
617
618int main(int argc, char** argv) {
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700619 enum { UNCRYPT, SETUP_BCB, CLEAR_BCB, UNCRYPT_DEBUG } action;
Tao Bao3a2bb592016-02-25 12:38:53 -0800620 const char* input_path = nullptr;
621 const char* map_file = CACHE_BLOCK_MAP.c_str();
622
623 if (argc == 2 && strcmp(argv[1], "--clear-bcb") == 0) {
624 action = CLEAR_BCB;
625 } else if (argc == 2 && strcmp(argv[1], "--setup-bcb") == 0) {
626 action = SETUP_BCB;
Tao Bao3a2bb592016-02-25 12:38:53 -0800627 } else if (argc == 1) {
628 action = UNCRYPT;
629 } else if (argc == 3) {
630 input_path = argv[1];
631 map_file = argv[2];
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700632 action = UNCRYPT_DEBUG;
Tao Bao3a2bb592016-02-25 12:38:53 -0800633 } else {
634 usage(argv[0]);
635 return 2;
Doug Zongker76adfc52014-01-13 10:04:25 -0800636 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800637
Tom Cherry772c93c2018-12-04 09:37:39 -0800638 if (!ReadDefaultFstab(&fstab)) {
639 LOG(ERROR) << "failed to read default fstab";
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700640 log_uncrypt_error_code(kUncryptFstabReadError);
Tao Bao3a2bb592016-02-25 12:38:53 -0800641 return 1;
642 }
643
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700644 if (action == UNCRYPT_DEBUG) {
Tianjie Xu74778142016-08-05 18:00:04 -0700645 LOG(INFO) << "uncrypt called in debug mode, skip socket communication";
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700646 bool success = uncrypt_wrapper(input_path, map_file, -1);
647 if (success) {
Tianjie Xu74778142016-08-05 18:00:04 -0700648 LOG(INFO) << "uncrypt succeeded";
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700649 } else{
Tianjie Xu74778142016-08-05 18:00:04 -0700650 LOG(INFO) << "uncrypt failed";
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700651 }
652 return success ? 0 : 1;
653 }
654
Tao Bao3a2bb592016-02-25 12:38:53 -0800655 // c3. The socket is created by init when starting the service. uncrypt
656 // will use the socket to communicate with its caller.
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700657 android::base::unique_fd service_socket(android_get_control_socket(UNCRYPT_SOCKET.c_str()));
658 if (service_socket == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700659 PLOG(ERROR) << "failed to open socket \"" << UNCRYPT_SOCKET << "\"";
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700660 log_uncrypt_error_code(kUncryptSocketOpenError);
Tao Bao3a2bb592016-02-25 12:38:53 -0800661 return 1;
662 }
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700663 fcntl(service_socket, F_SETFD, FD_CLOEXEC);
Tao Bao3a2bb592016-02-25 12:38:53 -0800664
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700665 if (listen(service_socket, 1) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700666 PLOG(ERROR) << "failed to listen on socket " << service_socket.get();
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700667 log_uncrypt_error_code(kUncryptSocketListenError);
Tao Bao3a2bb592016-02-25 12:38:53 -0800668 return 1;
669 }
670
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700671 android::base::unique_fd socket_fd(accept4(service_socket, nullptr, nullptr, SOCK_CLOEXEC));
672 if (socket_fd == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700673 PLOG(ERROR) << "failed to accept on socket " << service_socket.get();
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700674 log_uncrypt_error_code(kUncryptSocketAcceptError);
Tao Bao3a2bb592016-02-25 12:38:53 -0800675 return 1;
676 }
677
678 bool success = false;
679 switch (action) {
680 case UNCRYPT:
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700681 success = uncrypt_wrapper(input_path, map_file, socket_fd);
Tao Bao3a2bb592016-02-25 12:38:53 -0800682 break;
683 case SETUP_BCB:
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700684 success = setup_bcb(socket_fd);
Tao Bao3a2bb592016-02-25 12:38:53 -0800685 break;
686 case CLEAR_BCB:
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700687 success = clear_bcb(socket_fd);
Tao Bao3a2bb592016-02-25 12:38:53 -0800688 break;
689 default: // Should never happen.
Tianjie Xu74778142016-08-05 18:00:04 -0700690 LOG(ERROR) << "Invalid uncrypt action code: " << action;
Tao Bao3a2bb592016-02-25 12:38:53 -0800691 return 1;
692 }
693
694 // c13. Read a 4-byte code from the client before uncrypt exits. This is to
695 // ensure the client to receive the last status code before the socket gets
696 // destroyed.
697 int code;
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700698 if (android::base::ReadFully(socket_fd, &code, 4)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700699 LOG(INFO) << " received " << code << ", exiting now";
Tao Bao3a2bb592016-02-25 12:38:53 -0800700 } else {
Tianjie Xu74778142016-08-05 18:00:04 -0700701 PLOG(ERROR) << "failed to read the code";
Tao Bao3a2bb592016-02-25 12:38:53 -0800702 }
703 return success ? 0 : 1;
Doug Zongker76adfc52014-01-13 10:04:25 -0800704}