blob: 645faadbf41ee02dc8fad534454d69b81d8dbed3 [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>
Yabin Cui25dd0382016-02-01 11:40:37 -080092#include <libgen.h>
Tao Bao75238632015-05-27 14:46:17 -070093#include <linux/fs.h>
94#include <stdarg.h>
Doug Zongker76adfc52014-01-13 10:04:25 -080095#include <stdio.h>
96#include <stdlib.h>
Elliott Hughescd3c55a2015-01-29 20:50:08 -080097#include <string.h>
Doug Zongker76adfc52014-01-13 10:04:25 -080098#include <sys/mman.h>
Tao Bao3a2bb592016-02-25 12:38:53 -080099#include <sys/socket.h>
Tao Bao383b00d2015-05-21 16:44:44 -0700100#include <sys/stat.h>
101#include <sys/types.h>
Tao Bao75238632015-05-27 14:46:17 -0700102#include <unistd.h>
Doug Zongker76adfc52014-01-13 10:04:25 -0800103
Yabin Cui25dd0382016-02-01 11:40:37 -0800104#include <algorithm>
Tao Baoc7547922015-08-06 18:35:05 -0700105#include <memory>
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>
118
Tao Bao1fc5bf32017-10-06 07:43:41 -0700119#include "otautil/error_code.h"
Tianjie Xuda44cf12016-09-24 15:31:34 -0700120
Tianjie Xubc426032016-11-11 13:53:25 -0800121static constexpr int WINDOW_SIZE = 5;
122static constexpr int FIBMAP_RETRY_LIMIT = 3;
Tao Bao383b00d2015-05-21 16:44:44 -0700123
Tao Bao3a2bb592016-02-25 12:38:53 -0800124// uncrypt provides three services: SETUP_BCB, CLEAR_BCB and UNCRYPT.
125//
126// SETUP_BCB and CLEAR_BCB services use socket communication and do not rely
127// on /cache partitions. They will handle requests to reboot into recovery
128// (for applying updates for non-A/B devices, or factory resets for all
129// devices).
130//
131// UNCRYPT service still needs files on /cache partition (UNCRYPT_PATH_FILE
132// and CACHE_BLOCK_MAP). It will be working (and needed) only for non-A/B
133// devices, on which /cache partitions always exist.
Yabin Cui2d46da52016-01-26 16:50:15 -0800134static const std::string CACHE_BLOCK_MAP = "/cache/recovery/block.map";
Yabin Cui2d46da52016-01-26 16:50:15 -0800135static const std::string UNCRYPT_PATH_FILE = "/cache/recovery/uncrypt_file";
Tianjie Xue16e7992016-09-09 10:55:44 -0700136static const std::string UNCRYPT_STATUS = "/cache/recovery/uncrypt_status";
Tao Bao3a2bb592016-02-25 12:38:53 -0800137static const std::string UNCRYPT_SOCKET = "uncrypt";
Doug Zongker76adfc52014-01-13 10:04:25 -0800138
Tao Bao3a2bb592016-02-25 12:38:53 -0800139static struct fstab* fstab = nullptr;
Doug Zongker2efc9d92014-08-18 15:55:28 -0700140
Tao Bao381f4552015-05-05 18:36:45 -0700141static int write_at_offset(unsigned char* buffer, size_t size, int wfd, off64_t offset) {
Elliott Hughes7bad7c42015-04-28 17:24:24 -0700142 if (TEMP_FAILURE_RETRY(lseek64(wfd, offset, SEEK_SET)) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700143 PLOG(ERROR) << "error seeking to offset " << offset;
Elliott Hughes7bad7c42015-04-28 17:24:24 -0700144 return -1;
145 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800146 if (!android::base::WriteFully(wfd, buffer, size)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700147 PLOG(ERROR) << "error writing offset " << offset;
Yabin Cui25dd0382016-02-01 11:40:37 -0800148 return -1;
Doug Zongker76adfc52014-01-13 10:04:25 -0800149 }
150 return 0;
151}
152
Yabin Cui25dd0382016-02-01 11:40:37 -0800153static void add_block_to_ranges(std::vector<int>& ranges, int new_block) {
154 if (!ranges.empty() && new_block == ranges.back()) {
Doug Zongker76adfc52014-01-13 10:04:25 -0800155 // If the new block comes immediately after the current range,
156 // all we have to do is extend the current range.
Yabin Cui25dd0382016-02-01 11:40:37 -0800157 ++ranges.back();
Doug Zongker76adfc52014-01-13 10:04:25 -0800158 } else {
159 // We need to start a new range.
Yabin Cui25dd0382016-02-01 11:40:37 -0800160 ranges.push_back(new_block);
161 ranges.push_back(new_block + 1);
Doug Zongker76adfc52014-01-13 10:04:25 -0800162 }
163}
164
Tao Bao381f4552015-05-05 18:36:45 -0700165static struct fstab* read_fstab() {
Bowgo Tsaid13b6cf2017-03-10 16:00:40 +0800166 fstab = fs_mgr_read_fstab_default();
Doug Zongker76adfc52014-01-13 10:04:25 -0800167 if (!fstab) {
Bowgo Tsaid13b6cf2017-03-10 16:00:40 +0800168 LOG(ERROR) << "failed to read default fstab";
Doug Zongker76adfc52014-01-13 10:04:25 -0800169 return NULL;
170 }
171
Doug Zongker2efc9d92014-08-18 15:55:28 -0700172 return fstab;
173}
174
Tao Bao381f4552015-05-05 18:36:45 -0700175static const char* find_block_device(const char* path, bool* encryptable, bool* encrypted) {
Doug Zongker76adfc52014-01-13 10:04:25 -0800176 // Look for a volume whose mount point is the prefix of path and
177 // return its block device. Set encrypted if it's currently
178 // encrypted.
Tao Bao381f4552015-05-05 18:36:45 -0700179 for (int i = 0; i < fstab->num_entries; ++i) {
Doug Zongker76adfc52014-01-13 10:04:25 -0800180 struct fstab_rec* v = &fstab->recs[i];
Tao Bao381f4552015-05-05 18:36:45 -0700181 if (!v->mount_point) {
182 continue;
183 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800184 int len = strlen(v->mount_point);
185 if (strncmp(path, v->mount_point, len) == 0 &&
186 (path[len] == '/' || path[len] == 0)) {
Tao Bao381f4552015-05-05 18:36:45 -0700187 *encrypted = false;
188 *encryptable = false;
Tao Bao7cf50c62015-07-16 20:04:13 -0700189 if (fs_mgr_is_encryptable(v) || fs_mgr_is_file_encrypted(v)) {
Tao Bao381f4552015-05-05 18:36:45 -0700190 *encryptable = true;
Elliott Hughes91e3aee2016-09-23 15:30:55 -0700191 if (android::base::GetProperty("ro.crypto.state", "") == "encrypted") {
Tao Bao381f4552015-05-05 18:36:45 -0700192 *encrypted = true;
Doug Zongker76adfc52014-01-13 10:04:25 -0800193 }
194 }
195 return v->blk_device;
196 }
197 }
198
199 return NULL;
200}
201
Tao Bao3a2bb592016-02-25 12:38:53 -0800202static bool write_status_to_socket(int status, int socket) {
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700203 // If socket equals -1, uncrypt is in debug mode without socket communication.
204 // Skip writing and return success.
205 if (socket == -1) {
206 return true;
207 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800208 int status_out = htonl(status);
209 return android::base::WriteFully(socket, &status_out, sizeof(int));
210}
211
Tao Bao383b00d2015-05-21 16:44:44 -0700212// Parse uncrypt_file to find the update package name.
Yabin Cui2d46da52016-01-26 16:50:15 -0800213static bool find_uncrypt_package(const std::string& uncrypt_path_file, std::string* package_name) {
214 CHECK(package_name != nullptr);
215 std::string uncrypt_path;
216 if (!android::base::ReadFileToString(uncrypt_path_file, &uncrypt_path)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700217 PLOG(ERROR) << "failed to open \"" << uncrypt_path_file << "\"";
Tao Bao383b00d2015-05-21 16:44:44 -0700218 return false;
Maxim Siniavinee7b28882014-02-13 15:48:53 -0800219 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800220
Tao Bao383b00d2015-05-21 16:44:44 -0700221 // Remove the trailing '\n' if present.
Yabin Cui2d46da52016-01-26 16:50:15 -0800222 *package_name = android::base::Trim(uncrypt_path);
Tao Bao383b00d2015-05-21 16:44:44 -0700223 return true;
Doug Zongker76adfc52014-01-13 10:04:25 -0800224}
225
Tianjie Xubc426032016-11-11 13:53:25 -0800226static int retry_fibmap(const int fd, const char* name, int* block, const int head_block) {
227 CHECK(block != nullptr);
228 for (size_t i = 0; i < FIBMAP_RETRY_LIMIT; i++) {
229 if (fsync(fd) == -1) {
230 PLOG(ERROR) << "failed to fsync \"" << name << "\"";
231 return kUncryptFileSyncError;
232 }
233 if (ioctl(fd, FIBMAP, block) != 0) {
234 PLOG(ERROR) << "failed to find block " << head_block;
235 return kUncryptIoctlError;
236 }
237 if (*block != 0) {
238 return kUncryptNoError;
239 }
240 sleep(1);
241 }
242 LOG(ERROR) << "fibmap of " << head_block << "always returns 0";
243 return kUncryptIoctlError;
244}
245
Tao Bao381f4552015-05-05 18:36:45 -0700246static int produce_block_map(const char* path, const char* map_file, const char* blk_dev,
Tao Bao3a2bb592016-02-25 12:38:53 -0800247 bool encrypted, int socket) {
Yabin Cui25dd0382016-02-01 11:40:37 -0800248 std::string err;
249 if (!android::base::RemoveFileIfExists(map_file, &err)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700250 LOG(ERROR) << "failed to remove the existing map file " << map_file << ": " << err;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700251 return kUncryptFileRemoveError;
Sungmin Choia72512c2014-12-10 21:57:09 +0900252 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800253 std::string tmp_map_file = std::string(map_file) + ".tmp";
Elliott Hughesbcabd092016-03-22 20:19:22 -0700254 android::base::unique_fd mapfd(open(tmp_map_file.c_str(),
255 O_WRONLY | O_CREAT, S_IRUSR | S_IWUSR));
256 if (mapfd == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700257 PLOG(ERROR) << "failed to open " << tmp_map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700258 return kUncryptFileOpenError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800259 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800260
Tao Bao3a2bb592016-02-25 12:38:53 -0800261 // Make sure we can write to the socket.
262 if (!write_status_to_socket(0, socket)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700263 LOG(ERROR) << "failed to write to socket " << socket;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700264 return kUncryptSocketWriteError;
Tao Bao383b00d2015-05-21 16:44:44 -0700265 }
266
Tao Bao381f4552015-05-05 18:36:45 -0700267 struct stat sb;
Tao Baoc7547922015-08-06 18:35:05 -0700268 if (stat(path, &sb) != 0) {
Tianjie Xu74778142016-08-05 18:00:04 -0700269 LOG(ERROR) << "failed to stat " << path;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700270 return kUncryptFileStatError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800271 }
272
Tianjie Xu74778142016-08-05 18:00:04 -0700273 LOG(INFO) << " block size: " << sb.st_blksize << " bytes";
Doug Zongker76adfc52014-01-13 10:04:25 -0800274
275 int blocks = ((sb.st_size-1) / sb.st_blksize) + 1;
Tianjie Xu74778142016-08-05 18:00:04 -0700276 LOG(INFO) << " file size: " << sb.st_size << " bytes, " << blocks << " blocks";
Doug Zongker76adfc52014-01-13 10:04:25 -0800277
Yabin Cui25dd0382016-02-01 11:40:37 -0800278 std::vector<int> ranges;
Doug Zongker76adfc52014-01-13 10:04:25 -0800279
Chih-Hung Hsieh54a27472016-04-18 11:30:55 -0700280 std::string s = android::base::StringPrintf("%s\n%" PRId64 " %" PRId64 "\n",
281 blk_dev, static_cast<int64_t>(sb.st_size),
282 static_cast<int64_t>(sb.st_blksize));
Elliott Hughesbcabd092016-03-22 20:19:22 -0700283 if (!android::base::WriteStringToFd(s, mapfd)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700284 PLOG(ERROR) << "failed to write " << tmp_map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700285 return kUncryptWriteError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800286 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800287
Yabin Cui25dd0382016-02-01 11:40:37 -0800288 std::vector<std::vector<unsigned char>> buffers;
Doug Zongker76adfc52014-01-13 10:04:25 -0800289 if (encrypted) {
Yabin Cui25dd0382016-02-01 11:40:37 -0800290 buffers.resize(WINDOW_SIZE, std::vector<unsigned char>(sb.st_blksize));
Doug Zongker76adfc52014-01-13 10:04:25 -0800291 }
292 int head_block = 0;
293 int head = 0, tail = 0;
Doug Zongker76adfc52014-01-13 10:04:25 -0800294
Elliott Hughesbcabd092016-03-22 20:19:22 -0700295 android::base::unique_fd fd(open(path, O_RDONLY));
296 if (fd == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700297 PLOG(ERROR) << "failed to open " << path << " for reading";
Tianjie Xuda44cf12016-09-24 15:31:34 -0700298 return kUncryptFileOpenError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800299 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800300
Elliott Hughesbcabd092016-03-22 20:19:22 -0700301 android::base::unique_fd wfd;
Doug Zongker76adfc52014-01-13 10:04:25 -0800302 if (encrypted) {
Elliott Hughesbcabd092016-03-22 20:19:22 -0700303 wfd.reset(open(blk_dev, O_WRONLY));
304 if (wfd == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700305 PLOG(ERROR) << "failed to open " << blk_dev << " for writing";
Tianjie Xuda44cf12016-09-24 15:31:34 -0700306 return kUncryptBlockOpenError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800307 }
308 }
309
Tao Baob8df5fb2015-12-08 22:47:25 -0800310 off64_t pos = 0;
Tao Bao383b00d2015-05-21 16:44:44 -0700311 int last_progress = 0;
Doug Zongker76adfc52014-01-13 10:04:25 -0800312 while (pos < sb.st_size) {
Tao Bao383b00d2015-05-21 16:44:44 -0700313 // Update the status file, progress must be between [0, 99].
314 int progress = static_cast<int>(100 * (double(pos) / double(sb.st_size)));
315 if (progress > last_progress) {
Tao Bao3a2bb592016-02-25 12:38:53 -0800316 last_progress = progress;
317 write_status_to_socket(progress, socket);
Tao Bao383b00d2015-05-21 16:44:44 -0700318 }
319
Doug Zongker76adfc52014-01-13 10:04:25 -0800320 if ((tail+1) % WINDOW_SIZE == head) {
321 // write out head buffer
322 int block = head_block;
Elliott Hughesbcabd092016-03-22 20:19:22 -0700323 if (ioctl(fd, FIBMAP, &block) != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700324 PLOG(ERROR) << "failed to find block " << head_block;
325 return kUncryptIoctlError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800326 }
Tianjie Xubc426032016-11-11 13:53:25 -0800327
328 if (block == 0) {
329 LOG(ERROR) << "failed to find block " << head_block << ", retrying";
330 int error = retry_fibmap(fd, path, &block, head_block);
331 if (error != kUncryptNoError) {
332 return error;
333 }
334 }
335
Yabin Cui25dd0382016-02-01 11:40:37 -0800336 add_block_to_ranges(ranges, block);
Doug Zongker76adfc52014-01-13 10:04:25 -0800337 if (encrypted) {
Elliott Hughesbcabd092016-03-22 20:19:22 -0700338 if (write_at_offset(buffers[head].data(), sb.st_blksize, wfd,
339 static_cast<off64_t>(sb.st_blksize) * block) != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700340 return kUncryptWriteError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800341 }
342 }
343 head = (head + 1) % WINDOW_SIZE;
344 ++head_block;
345 }
346
347 // read next block to tail
348 if (encrypted) {
Yabin Cui25dd0382016-02-01 11:40:37 -0800349 size_t to_read = static_cast<size_t>(
350 std::min(static_cast<off64_t>(sb.st_blksize), sb.st_size - pos));
Elliott Hughesbcabd092016-03-22 20:19:22 -0700351 if (!android::base::ReadFully(fd, buffers[tail].data(), to_read)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700352 PLOG(ERROR) << "failed to read " << path;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700353 return kUncryptReadError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800354 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800355 pos += to_read;
Doug Zongker76adfc52014-01-13 10:04:25 -0800356 } else {
357 // If we're not encrypting; we don't need to actually read
358 // anything, just skip pos forward as if we'd read a
359 // block.
360 pos += sb.st_blksize;
361 }
362 tail = (tail+1) % WINDOW_SIZE;
363 }
364
365 while (head != tail) {
366 // write out head buffer
367 int block = head_block;
Elliott Hughesbcabd092016-03-22 20:19:22 -0700368 if (ioctl(fd, FIBMAP, &block) != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700369 PLOG(ERROR) << "failed to find block " << head_block;
370 return kUncryptIoctlError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800371 }
Tianjie Xubc426032016-11-11 13:53:25 -0800372
373 if (block == 0) {
374 LOG(ERROR) << "failed to find block " << head_block << ", retrying";
375 int error = retry_fibmap(fd, path, &block, head_block);
376 if (error != kUncryptNoError) {
377 return error;
378 }
379 }
380
Yabin Cui25dd0382016-02-01 11:40:37 -0800381 add_block_to_ranges(ranges, block);
Doug Zongker76adfc52014-01-13 10:04:25 -0800382 if (encrypted) {
Elliott Hughesbcabd092016-03-22 20:19:22 -0700383 if (write_at_offset(buffers[head].data(), sb.st_blksize, wfd,
384 static_cast<off64_t>(sb.st_blksize) * block) != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700385 return kUncryptWriteError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800386 }
387 }
388 head = (head + 1) % WINDOW_SIZE;
389 ++head_block;
390 }
391
Yabin Cui25dd0382016-02-01 11:40:37 -0800392 if (!android::base::WriteStringToFd(
Elliott Hughesbcabd092016-03-22 20:19:22 -0700393 android::base::StringPrintf("%zu\n", ranges.size() / 2), mapfd)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700394 PLOG(ERROR) << "failed to write " << tmp_map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700395 return kUncryptWriteError;
Tao Baofb4ccef2015-05-04 10:10:13 -0700396 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800397 for (size_t i = 0; i < ranges.size(); i += 2) {
398 if (!android::base::WriteStringToFd(
Elliott Hughesbcabd092016-03-22 20:19:22 -0700399 android::base::StringPrintf("%d %d\n", ranges[i], ranges[i+1]), mapfd)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700400 PLOG(ERROR) << "failed to write " << tmp_map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700401 return kUncryptWriteError;
Tao Baofb4ccef2015-05-04 10:10:13 -0700402 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800403 }
404
Elliott Hughesbcabd092016-03-22 20:19:22 -0700405 if (fsync(mapfd) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700406 PLOG(ERROR) << "failed to fsync \"" << tmp_map_file << "\"";
Tianjie Xuda44cf12016-09-24 15:31:34 -0700407 return kUncryptFileSyncError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800408 }
Elliott Hughesbcabd092016-03-22 20:19:22 -0700409 if (close(mapfd.release()) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700410 PLOG(ERROR) << "failed to close " << tmp_map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700411 return kUncryptFileCloseError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800412 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800413
414 if (encrypted) {
Elliott Hughesbcabd092016-03-22 20:19:22 -0700415 if (fsync(wfd) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700416 PLOG(ERROR) << "failed to fsync \"" << blk_dev << "\"";
Tianjie Xuda44cf12016-09-24 15:31:34 -0700417 return kUncryptFileSyncError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800418 }
Elliott Hughesbcabd092016-03-22 20:19:22 -0700419 if (close(wfd.release()) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700420 PLOG(ERROR) << "failed to close " << blk_dev;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700421 return kUncryptFileCloseError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800422 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800423 }
424
425 if (rename(tmp_map_file.c_str(), map_file) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700426 PLOG(ERROR) << "failed to rename " << tmp_map_file << " to " << map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700427 return kUncryptFileRenameError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800428 }
429 // Sync dir to make rename() result written to disk.
430 std::string file_name = map_file;
431 std::string dir_name = dirname(&file_name[0]);
Elliott Hughesbcabd092016-03-22 20:19:22 -0700432 android::base::unique_fd dfd(open(dir_name.c_str(), O_RDONLY | O_DIRECTORY));
433 if (dfd == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700434 PLOG(ERROR) << "failed to open dir " << dir_name;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700435 return kUncryptFileOpenError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800436 }
Elliott Hughesbcabd092016-03-22 20:19:22 -0700437 if (fsync(dfd) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700438 PLOG(ERROR) << "failed to fsync " << dir_name;
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(dfd.release()) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700442 PLOG(ERROR) << "failed to close " << dir_name;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700443 return kUncryptFileCloseError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800444 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800445 return 0;
446}
447
Tao Bao3a2bb592016-02-25 12:38:53 -0800448static int uncrypt(const char* input_path, const char* map_file, const int socket) {
Tianjie Xu74778142016-08-05 18:00:04 -0700449 LOG(INFO) << "update package is \"" << input_path << "\"";
Doug Zongkerf449db22014-08-26 09:15:08 -0700450
Tianjie Xu8b8e23d2017-07-27 11:42:17 -0700451 // Turn the name of the file we're supposed to convert into an absolute path, so we can find
452 // what filesystem it's on.
Doug Zongker76adfc52014-01-13 10:04:25 -0800453 char path[PATH_MAX+1];
Tianjie Xu8b8e23d2017-07-27 11:42:17 -0700454 if (realpath(input_path, path) == nullptr) {
Tianjie Xu74778142016-08-05 18:00:04 -0700455 PLOG(ERROR) << "failed to convert \"" << input_path << "\" to absolute path";
Tianjie Xu8b8e23d2017-07-27 11:42:17 -0700456 return kUncryptRealpathFindError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800457 }
458
Tao Bao381f4552015-05-05 18:36:45 -0700459 bool encryptable;
460 bool encrypted;
Doug Zongker76adfc52014-01-13 10:04:25 -0800461 const char* blk_dev = find_block_device(path, &encryptable, &encrypted);
Tianjie Xu8b8e23d2017-07-27 11:42:17 -0700462 if (blk_dev == nullptr) {
Tianjie Xu74778142016-08-05 18:00:04 -0700463 LOG(ERROR) << "failed to find block device for " << path;
Tianjie Xu8b8e23d2017-07-27 11:42:17 -0700464 return kUncryptBlockDeviceFindError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800465 }
466
467 // If the filesystem it's on isn't encrypted, we only produce the
468 // block map, we don't rewrite the file contents (it would be
469 // pointless to do so).
Tianjie Xu74778142016-08-05 18:00:04 -0700470 LOG(INFO) << "encryptable: " << (encryptable ? "yes" : "no");
471 LOG(INFO) << " encrypted: " << (encrypted ? "yes" : "no");
Doug Zongker76adfc52014-01-13 10:04:25 -0800472
Doug Zongker574443d2014-09-05 08:22:12 -0700473 // Recovery supports installing packages from 3 paths: /cache,
474 // /data, and /sdcard. (On a particular device, other locations
475 // may work, but those are three we actually expect.)
476 //
477 // On /data we want to convert the file to a block map so that we
478 // can read the package without mounting the partition. On /cache
479 // and /sdcard we leave the file alone.
Tao Bao383b00d2015-05-21 16:44:44 -0700480 if (strncmp(path, "/data/", 6) == 0) {
Tianjie Xu74778142016-08-05 18:00:04 -0700481 LOG(INFO) << "writing block map " << map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700482 return produce_block_map(path, map_file, blk_dev, encrypted, socket);
Tao Bao383b00d2015-05-21 16:44:44 -0700483 }
484
485 return 0;
486}
487
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700488static void log_uncrypt_error_code(UncryptErrorCode error_code) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700489 if (!android::base::WriteStringToFile(android::base::StringPrintf(
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700490 "uncrypt_error: %d\n", error_code), UNCRYPT_STATUS)) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700491 PLOG(WARNING) << "failed to write to " << UNCRYPT_STATUS;
492 }
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700493}
494
495static bool uncrypt_wrapper(const char* input_path, const char* map_file, const int socket) {
496 // Initialize the uncrypt error to kUncryptErrorPlaceholder.
497 log_uncrypt_error_code(kUncryptErrorPlaceholder);
Tianjie Xuda44cf12016-09-24 15:31:34 -0700498
Yabin Cui2d46da52016-01-26 16:50:15 -0800499 std::string package;
500 if (input_path == nullptr) {
501 if (!find_uncrypt_package(UNCRYPT_PATH_FILE, &package)) {
Tao Bao3a2bb592016-02-25 12:38:53 -0800502 write_status_to_socket(-1, socket);
Tianjie Xuda44cf12016-09-24 15:31:34 -0700503 // Overwrite the error message.
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700504 log_uncrypt_error_code(kUncryptPackageMissingError);
Tao Bao3a2bb592016-02-25 12:38:53 -0800505 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800506 }
507 input_path = package.c_str();
508 }
509 CHECK(map_file != nullptr);
Tianjie Xue16e7992016-09-09 10:55:44 -0700510
Tianjie Xue16e7992016-09-09 10:55:44 -0700511 auto start = std::chrono::system_clock::now();
Tao Bao3a2bb592016-02-25 12:38:53 -0800512 int status = uncrypt(input_path, map_file, socket);
Tianjie Xuda44cf12016-09-24 15:31:34 -0700513 std::chrono::duration<double> duration = std::chrono::system_clock::now() - start;
514 int count = static_cast<int>(duration.count());
515
516 std::string uncrypt_message = android::base::StringPrintf("uncrypt_time: %d\n", count);
Yabin Cui2d46da52016-01-26 16:50:15 -0800517 if (status != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700518 // Log the time cost and error code if uncrypt fails.
519 uncrypt_message += android::base::StringPrintf("uncrypt_error: %d\n", status);
520 if (!android::base::WriteStringToFile(uncrypt_message, UNCRYPT_STATUS)) {
521 PLOG(WARNING) << "failed to write to " << UNCRYPT_STATUS;
522 }
523
Tao Bao3a2bb592016-02-25 12:38:53 -0800524 write_status_to_socket(-1, socket);
525 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800526 }
Tianjie Xue16e7992016-09-09 10:55:44 -0700527
Tianjie Xuda44cf12016-09-24 15:31:34 -0700528 if (!android::base::WriteStringToFile(uncrypt_message, UNCRYPT_STATUS)) {
Tianjie Xue16e7992016-09-09 10:55:44 -0700529 PLOG(WARNING) << "failed to write to " << UNCRYPT_STATUS;
530 }
531
Tao Bao3a2bb592016-02-25 12:38:53 -0800532 write_status_to_socket(100, socket);
Tianjie Xue16e7992016-09-09 10:55:44 -0700533
Tao Bao3a2bb592016-02-25 12:38:53 -0800534 return true;
Yabin Cui2d46da52016-01-26 16:50:15 -0800535}
536
Tao Bao3a2bb592016-02-25 12:38:53 -0800537static bool clear_bcb(const int socket) {
Yabin Cuia58a6db2016-04-06 15:52:18 -0700538 std::string err;
539 if (!clear_bootloader_message(&err)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700540 LOG(ERROR) << "failed to clear bootloader message: " << err;
Tao Bao3a2bb592016-02-25 12:38:53 -0800541 write_status_to_socket(-1, socket);
542 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800543 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800544 write_status_to_socket(100, socket);
545 return true;
Yabin Cui2d46da52016-01-26 16:50:15 -0800546}
547
Tao Bao3a2bb592016-02-25 12:38:53 -0800548static bool setup_bcb(const int socket) {
549 // c5. receive message length
550 int length;
551 if (!android::base::ReadFully(socket, &length, 4)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700552 PLOG(ERROR) << "failed to read the length";
Tao Bao3a2bb592016-02-25 12:38:53 -0800553 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800554 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800555 length = ntohl(length);
556
557 // c7. receive message
Yabin Cui2d46da52016-01-26 16:50:15 -0800558 std::string content;
Tao Bao3a2bb592016-02-25 12:38:53 -0800559 content.resize(length);
560 if (!android::base::ReadFully(socket, &content[0], length)) {
Tao Bao10334082016-12-12 17:10:20 -0800561 PLOG(ERROR) << "failed to read the message";
Tao Bao3a2bb592016-02-25 12:38:53 -0800562 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800563 }
Tianjie Xu74778142016-08-05 18:00:04 -0700564 LOG(INFO) << " received command: [" << content << "] (" << content.size() << ")";
Yabin Cui6faf0262016-06-09 14:09:39 -0700565 std::vector<std::string> options = android::base::Split(content, "\n");
566 std::string wipe_package;
567 for (auto& option : options) {
568 if (android::base::StartsWith(option, "--wipe_package=")) {
569 std::string path = option.substr(strlen("--wipe_package="));
570 if (!android::base::ReadFileToString(path, &wipe_package)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700571 PLOG(ERROR) << "failed to read " << path;
Yabin Cui6faf0262016-06-09 14:09:39 -0700572 return false;
573 }
574 option = android::base::StringPrintf("--wipe_package_size=%zu", wipe_package.size());
575 }
576 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800577
578 // c8. setup the bcb command
Yabin Cuia58a6db2016-04-06 15:52:18 -0700579 std::string err;
Yabin Cui6faf0262016-06-09 14:09:39 -0700580 if (!write_bootloader_message(options, &err)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700581 LOG(ERROR) << "failed to set bootloader message: " << err;
Tao Bao3a2bb592016-02-25 12:38:53 -0800582 write_status_to_socket(-1, socket);
583 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800584 }
Yabin Cui6faf0262016-06-09 14:09:39 -0700585 if (!wipe_package.empty() && !write_wipe_package(wipe_package, &err)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700586 PLOG(ERROR) << "failed to set wipe package: " << err;
Yabin Cui6faf0262016-06-09 14:09:39 -0700587 write_status_to_socket(-1, socket);
588 return false;
589 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800590 // c10. send "100" status
591 write_status_to_socket(100, socket);
592 return true;
Yabin Cui2d46da52016-01-26 16:50:15 -0800593}
594
Yabin Cui2d46da52016-01-26 16:50:15 -0800595static void usage(const char* exename) {
596 fprintf(stderr, "Usage of %s:\n", exename);
597 fprintf(stderr, "%s [<package_path> <map_file>] Uncrypt ota package.\n", exename);
Yabin Cui2d46da52016-01-26 16:50:15 -0800598 fprintf(stderr, "%s --clear-bcb Clear BCB data in misc partition.\n", exename);
599 fprintf(stderr, "%s --setup-bcb Setup BCB data by command file.\n", exename);
Yabin Cui2d46da52016-01-26 16:50:15 -0800600}
601
602int main(int argc, char** argv) {
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700603 enum { UNCRYPT, SETUP_BCB, CLEAR_BCB, UNCRYPT_DEBUG } action;
Tao Bao3a2bb592016-02-25 12:38:53 -0800604 const char* input_path = nullptr;
605 const char* map_file = CACHE_BLOCK_MAP.c_str();
606
607 if (argc == 2 && strcmp(argv[1], "--clear-bcb") == 0) {
608 action = CLEAR_BCB;
609 } else if (argc == 2 && strcmp(argv[1], "--setup-bcb") == 0) {
610 action = SETUP_BCB;
Tao Bao3a2bb592016-02-25 12:38:53 -0800611 } else if (argc == 1) {
612 action = UNCRYPT;
613 } else if (argc == 3) {
614 input_path = argv[1];
615 map_file = argv[2];
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700616 action = UNCRYPT_DEBUG;
Tao Bao3a2bb592016-02-25 12:38:53 -0800617 } else {
618 usage(argv[0]);
619 return 2;
Doug Zongker76adfc52014-01-13 10:04:25 -0800620 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800621
622 if ((fstab = read_fstab()) == nullptr) {
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700623 log_uncrypt_error_code(kUncryptFstabReadError);
Tao Bao3a2bb592016-02-25 12:38:53 -0800624 return 1;
625 }
626
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700627 if (action == UNCRYPT_DEBUG) {
Tianjie Xu74778142016-08-05 18:00:04 -0700628 LOG(INFO) << "uncrypt called in debug mode, skip socket communication";
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700629 bool success = uncrypt_wrapper(input_path, map_file, -1);
630 if (success) {
Tianjie Xu74778142016-08-05 18:00:04 -0700631 LOG(INFO) << "uncrypt succeeded";
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700632 } else{
Tianjie Xu74778142016-08-05 18:00:04 -0700633 LOG(INFO) << "uncrypt failed";
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700634 }
635 return success ? 0 : 1;
636 }
637
Tao Bao3a2bb592016-02-25 12:38:53 -0800638 // c3. The socket is created by init when starting the service. uncrypt
639 // will use the socket to communicate with its caller.
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700640 android::base::unique_fd service_socket(android_get_control_socket(UNCRYPT_SOCKET.c_str()));
641 if (service_socket == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700642 PLOG(ERROR) << "failed to open socket \"" << UNCRYPT_SOCKET << "\"";
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700643 log_uncrypt_error_code(kUncryptSocketOpenError);
Tao Bao3a2bb592016-02-25 12:38:53 -0800644 return 1;
645 }
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700646 fcntl(service_socket, F_SETFD, FD_CLOEXEC);
Tao Bao3a2bb592016-02-25 12:38:53 -0800647
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700648 if (listen(service_socket, 1) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700649 PLOG(ERROR) << "failed to listen on socket " << service_socket.get();
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700650 log_uncrypt_error_code(kUncryptSocketListenError);
Tao Bao3a2bb592016-02-25 12:38:53 -0800651 return 1;
652 }
653
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700654 android::base::unique_fd socket_fd(accept4(service_socket, nullptr, nullptr, SOCK_CLOEXEC));
655 if (socket_fd == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700656 PLOG(ERROR) << "failed to accept on socket " << service_socket.get();
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700657 log_uncrypt_error_code(kUncryptSocketAcceptError);
Tao Bao3a2bb592016-02-25 12:38:53 -0800658 return 1;
659 }
660
661 bool success = false;
662 switch (action) {
663 case UNCRYPT:
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700664 success = uncrypt_wrapper(input_path, map_file, socket_fd);
Tao Bao3a2bb592016-02-25 12:38:53 -0800665 break;
666 case SETUP_BCB:
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700667 success = setup_bcb(socket_fd);
Tao Bao3a2bb592016-02-25 12:38:53 -0800668 break;
669 case CLEAR_BCB:
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700670 success = clear_bcb(socket_fd);
Tao Bao3a2bb592016-02-25 12:38:53 -0800671 break;
672 default: // Should never happen.
Tianjie Xu74778142016-08-05 18:00:04 -0700673 LOG(ERROR) << "Invalid uncrypt action code: " << action;
Tao Bao3a2bb592016-02-25 12:38:53 -0800674 return 1;
675 }
676
677 // c13. Read a 4-byte code from the client before uncrypt exits. This is to
678 // ensure the client to receive the last status code before the socket gets
679 // destroyed.
680 int code;
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700681 if (android::base::ReadFully(socket_fd, &code, 4)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700682 LOG(INFO) << " received " << code << ", exiting now";
Tao Bao3a2bb592016-02-25 12:38:53 -0800683 } else {
Tianjie Xu74778142016-08-05 18:00:04 -0700684 PLOG(ERROR) << "failed to read the code";
Tao Bao3a2bb592016-02-25 12:38:53 -0800685 }
686 return success ? 0 : 1;
Doug Zongker76adfc52014-01-13 10:04:25 -0800687}