blob: 4f5b2f8078dcb2560a26b21d5b4bbb286115cc63 [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
Tianjie Xuda44cf12016-09-24 15:31:34 -0700119#include "error_code.h"
120
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() {
Doug Zongker2efc9d92014-08-18 15:55:28 -0700166 fstab = NULL;
167
Doug Zongker76adfc52014-01-13 10:04:25 -0800168 // The fstab path is always "/fstab.${ro.hardware}".
Elliott Hughes91e3aee2016-09-23 15:30:55 -0700169 std::string ro_hardware = android::base::GetProperty("ro.hardware", "");
170 if (ro_hardware.empty()) {
Tianjie Xu74778142016-08-05 18:00:04 -0700171 LOG(ERROR) << "failed to get ro.hardware";
Doug Zongker76adfc52014-01-13 10:04:25 -0800172 return NULL;
173 }
174
Elliott Hughes91e3aee2016-09-23 15:30:55 -0700175 std::string fstab_path = "/fstab." + ro_hardware;
176
177 fstab = fs_mgr_read_fstab(fstab_path.c_str());
Doug Zongker76adfc52014-01-13 10:04:25 -0800178 if (!fstab) {
Tianjie Xu74778142016-08-05 18:00:04 -0700179 LOG(ERROR) << "failed to read " << fstab_path;
Doug Zongker76adfc52014-01-13 10:04:25 -0800180 return NULL;
181 }
182
Doug Zongker2efc9d92014-08-18 15:55:28 -0700183 return fstab;
184}
185
Tao Bao381f4552015-05-05 18:36:45 -0700186static const char* find_block_device(const char* path, bool* encryptable, bool* encrypted) {
Doug Zongker76adfc52014-01-13 10:04:25 -0800187 // Look for a volume whose mount point is the prefix of path and
188 // return its block device. Set encrypted if it's currently
189 // encrypted.
Tao Bao381f4552015-05-05 18:36:45 -0700190 for (int i = 0; i < fstab->num_entries; ++i) {
Doug Zongker76adfc52014-01-13 10:04:25 -0800191 struct fstab_rec* v = &fstab->recs[i];
Tao Bao381f4552015-05-05 18:36:45 -0700192 if (!v->mount_point) {
193 continue;
194 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800195 int len = strlen(v->mount_point);
196 if (strncmp(path, v->mount_point, len) == 0 &&
197 (path[len] == '/' || path[len] == 0)) {
Tao Bao381f4552015-05-05 18:36:45 -0700198 *encrypted = false;
199 *encryptable = false;
Tao Bao7cf50c62015-07-16 20:04:13 -0700200 if (fs_mgr_is_encryptable(v) || fs_mgr_is_file_encrypted(v)) {
Tao Bao381f4552015-05-05 18:36:45 -0700201 *encryptable = true;
Elliott Hughes91e3aee2016-09-23 15:30:55 -0700202 if (android::base::GetProperty("ro.crypto.state", "") == "encrypted") {
Tao Bao381f4552015-05-05 18:36:45 -0700203 *encrypted = true;
Doug Zongker76adfc52014-01-13 10:04:25 -0800204 }
205 }
206 return v->blk_device;
207 }
208 }
209
210 return NULL;
211}
212
Tao Bao3a2bb592016-02-25 12:38:53 -0800213static bool write_status_to_socket(int status, int socket) {
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700214 // If socket equals -1, uncrypt is in debug mode without socket communication.
215 // Skip writing and return success.
216 if (socket == -1) {
217 return true;
218 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800219 int status_out = htonl(status);
220 return android::base::WriteFully(socket, &status_out, sizeof(int));
221}
222
Tao Bao383b00d2015-05-21 16:44:44 -0700223// Parse uncrypt_file to find the update package name.
Yabin Cui2d46da52016-01-26 16:50:15 -0800224static bool find_uncrypt_package(const std::string& uncrypt_path_file, std::string* package_name) {
225 CHECK(package_name != nullptr);
226 std::string uncrypt_path;
227 if (!android::base::ReadFileToString(uncrypt_path_file, &uncrypt_path)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700228 PLOG(ERROR) << "failed to open \"" << uncrypt_path_file << "\"";
Tao Bao383b00d2015-05-21 16:44:44 -0700229 return false;
Maxim Siniavinee7b28882014-02-13 15:48:53 -0800230 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800231
Tao Bao383b00d2015-05-21 16:44:44 -0700232 // Remove the trailing '\n' if present.
Yabin Cui2d46da52016-01-26 16:50:15 -0800233 *package_name = android::base::Trim(uncrypt_path);
Tao Bao383b00d2015-05-21 16:44:44 -0700234 return true;
Doug Zongker76adfc52014-01-13 10:04:25 -0800235}
236
Tianjie Xubc426032016-11-11 13:53:25 -0800237static int retry_fibmap(const int fd, const char* name, int* block, const int head_block) {
238 CHECK(block != nullptr);
239 for (size_t i = 0; i < FIBMAP_RETRY_LIMIT; i++) {
240 if (fsync(fd) == -1) {
241 PLOG(ERROR) << "failed to fsync \"" << name << "\"";
242 return kUncryptFileSyncError;
243 }
244 if (ioctl(fd, FIBMAP, block) != 0) {
245 PLOG(ERROR) << "failed to find block " << head_block;
246 return kUncryptIoctlError;
247 }
248 if (*block != 0) {
249 return kUncryptNoError;
250 }
251 sleep(1);
252 }
253 LOG(ERROR) << "fibmap of " << head_block << "always returns 0";
254 return kUncryptIoctlError;
255}
256
Tao Bao381f4552015-05-05 18:36:45 -0700257static int produce_block_map(const char* path, const char* map_file, const char* blk_dev,
Tao Bao3a2bb592016-02-25 12:38:53 -0800258 bool encrypted, int socket) {
Yabin Cui25dd0382016-02-01 11:40:37 -0800259 std::string err;
260 if (!android::base::RemoveFileIfExists(map_file, &err)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700261 LOG(ERROR) << "failed to remove the existing map file " << map_file << ": " << err;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700262 return kUncryptFileRemoveError;
Sungmin Choia72512c2014-12-10 21:57:09 +0900263 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800264 std::string tmp_map_file = std::string(map_file) + ".tmp";
Elliott Hughesbcabd092016-03-22 20:19:22 -0700265 android::base::unique_fd mapfd(open(tmp_map_file.c_str(),
266 O_WRONLY | O_CREAT, S_IRUSR | S_IWUSR));
267 if (mapfd == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700268 PLOG(ERROR) << "failed to open " << tmp_map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700269 return kUncryptFileOpenError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800270 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800271
Tao Bao3a2bb592016-02-25 12:38:53 -0800272 // Make sure we can write to the socket.
273 if (!write_status_to_socket(0, socket)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700274 LOG(ERROR) << "failed to write to socket " << socket;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700275 return kUncryptSocketWriteError;
Tao Bao383b00d2015-05-21 16:44:44 -0700276 }
277
Tao Bao381f4552015-05-05 18:36:45 -0700278 struct stat sb;
Tao Baoc7547922015-08-06 18:35:05 -0700279 if (stat(path, &sb) != 0) {
Tianjie Xu74778142016-08-05 18:00:04 -0700280 LOG(ERROR) << "failed to stat " << path;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700281 return kUncryptFileStatError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800282 }
283
Tianjie Xu74778142016-08-05 18:00:04 -0700284 LOG(INFO) << " block size: " << sb.st_blksize << " bytes";
Doug Zongker76adfc52014-01-13 10:04:25 -0800285
286 int blocks = ((sb.st_size-1) / sb.st_blksize) + 1;
Tianjie Xu74778142016-08-05 18:00:04 -0700287 LOG(INFO) << " file size: " << sb.st_size << " bytes, " << blocks << " blocks";
Doug Zongker76adfc52014-01-13 10:04:25 -0800288
Yabin Cui25dd0382016-02-01 11:40:37 -0800289 std::vector<int> ranges;
Doug Zongker76adfc52014-01-13 10:04:25 -0800290
Chih-Hung Hsieh54a27472016-04-18 11:30:55 -0700291 std::string s = android::base::StringPrintf("%s\n%" PRId64 " %" PRId64 "\n",
292 blk_dev, static_cast<int64_t>(sb.st_size),
293 static_cast<int64_t>(sb.st_blksize));
Elliott Hughesbcabd092016-03-22 20:19:22 -0700294 if (!android::base::WriteStringToFd(s, mapfd)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700295 PLOG(ERROR) << "failed to write " << tmp_map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700296 return kUncryptWriteError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800297 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800298
Yabin Cui25dd0382016-02-01 11:40:37 -0800299 std::vector<std::vector<unsigned char>> buffers;
Doug Zongker76adfc52014-01-13 10:04:25 -0800300 if (encrypted) {
Yabin Cui25dd0382016-02-01 11:40:37 -0800301 buffers.resize(WINDOW_SIZE, std::vector<unsigned char>(sb.st_blksize));
Doug Zongker76adfc52014-01-13 10:04:25 -0800302 }
303 int head_block = 0;
304 int head = 0, tail = 0;
Doug Zongker76adfc52014-01-13 10:04:25 -0800305
Elliott Hughesbcabd092016-03-22 20:19:22 -0700306 android::base::unique_fd fd(open(path, O_RDONLY));
307 if (fd == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700308 PLOG(ERROR) << "failed to open " << path << " for reading";
Tianjie Xuda44cf12016-09-24 15:31:34 -0700309 return kUncryptFileOpenError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800310 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800311
Elliott Hughesbcabd092016-03-22 20:19:22 -0700312 android::base::unique_fd wfd;
Doug Zongker76adfc52014-01-13 10:04:25 -0800313 if (encrypted) {
Elliott Hughesbcabd092016-03-22 20:19:22 -0700314 wfd.reset(open(blk_dev, O_WRONLY));
315 if (wfd == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700316 PLOG(ERROR) << "failed to open " << blk_dev << " for writing";
Tianjie Xuda44cf12016-09-24 15:31:34 -0700317 return kUncryptBlockOpenError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800318 }
319 }
320
Tao Baob8df5fb2015-12-08 22:47:25 -0800321 off64_t pos = 0;
Tao Bao383b00d2015-05-21 16:44:44 -0700322 int last_progress = 0;
Doug Zongker76adfc52014-01-13 10:04:25 -0800323 while (pos < sb.st_size) {
Tao Bao383b00d2015-05-21 16:44:44 -0700324 // Update the status file, progress must be between [0, 99].
325 int progress = static_cast<int>(100 * (double(pos) / double(sb.st_size)));
326 if (progress > last_progress) {
Tao Bao3a2bb592016-02-25 12:38:53 -0800327 last_progress = progress;
328 write_status_to_socket(progress, socket);
Tao Bao383b00d2015-05-21 16:44:44 -0700329 }
330
Doug Zongker76adfc52014-01-13 10:04:25 -0800331 if ((tail+1) % WINDOW_SIZE == head) {
332 // write out head buffer
333 int block = head_block;
Elliott Hughesbcabd092016-03-22 20:19:22 -0700334 if (ioctl(fd, FIBMAP, &block) != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700335 PLOG(ERROR) << "failed to find block " << head_block;
336 return kUncryptIoctlError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800337 }
Tianjie Xubc426032016-11-11 13:53:25 -0800338
339 if (block == 0) {
340 LOG(ERROR) << "failed to find block " << head_block << ", retrying";
341 int error = retry_fibmap(fd, path, &block, head_block);
342 if (error != kUncryptNoError) {
343 return error;
344 }
345 }
346
Yabin Cui25dd0382016-02-01 11:40:37 -0800347 add_block_to_ranges(ranges, block);
Doug Zongker76adfc52014-01-13 10:04:25 -0800348 if (encrypted) {
Elliott Hughesbcabd092016-03-22 20:19:22 -0700349 if (write_at_offset(buffers[head].data(), sb.st_blksize, wfd,
350 static_cast<off64_t>(sb.st_blksize) * block) != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700351 return kUncryptWriteError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800352 }
353 }
354 head = (head + 1) % WINDOW_SIZE;
355 ++head_block;
356 }
357
358 // read next block to tail
359 if (encrypted) {
Yabin Cui25dd0382016-02-01 11:40:37 -0800360 size_t to_read = static_cast<size_t>(
361 std::min(static_cast<off64_t>(sb.st_blksize), sb.st_size - pos));
Elliott Hughesbcabd092016-03-22 20:19:22 -0700362 if (!android::base::ReadFully(fd, buffers[tail].data(), to_read)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700363 PLOG(ERROR) << "failed to read " << path;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700364 return kUncryptReadError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800365 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800366 pos += to_read;
Doug Zongker76adfc52014-01-13 10:04:25 -0800367 } else {
368 // If we're not encrypting; we don't need to actually read
369 // anything, just skip pos forward as if we'd read a
370 // block.
371 pos += sb.st_blksize;
372 }
373 tail = (tail+1) % WINDOW_SIZE;
374 }
375
376 while (head != tail) {
377 // write out head buffer
378 int block = head_block;
Elliott Hughesbcabd092016-03-22 20:19:22 -0700379 if (ioctl(fd, FIBMAP, &block) != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700380 PLOG(ERROR) << "failed to find block " << head_block;
381 return kUncryptIoctlError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800382 }
Tianjie Xubc426032016-11-11 13:53:25 -0800383
384 if (block == 0) {
385 LOG(ERROR) << "failed to find block " << head_block << ", retrying";
386 int error = retry_fibmap(fd, path, &block, head_block);
387 if (error != kUncryptNoError) {
388 return error;
389 }
390 }
391
Yabin Cui25dd0382016-02-01 11:40:37 -0800392 add_block_to_ranges(ranges, block);
Doug Zongker76adfc52014-01-13 10:04:25 -0800393 if (encrypted) {
Elliott Hughesbcabd092016-03-22 20:19:22 -0700394 if (write_at_offset(buffers[head].data(), sb.st_blksize, wfd,
395 static_cast<off64_t>(sb.st_blksize) * block) != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700396 return kUncryptWriteError;
Doug Zongker76adfc52014-01-13 10:04:25 -0800397 }
398 }
399 head = (head + 1) % WINDOW_SIZE;
400 ++head_block;
401 }
402
Yabin Cui25dd0382016-02-01 11:40:37 -0800403 if (!android::base::WriteStringToFd(
Elliott Hughesbcabd092016-03-22 20:19:22 -0700404 android::base::StringPrintf("%zu\n", ranges.size() / 2), mapfd)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700405 PLOG(ERROR) << "failed to write " << tmp_map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700406 return kUncryptWriteError;
Tao Baofb4ccef2015-05-04 10:10:13 -0700407 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800408 for (size_t i = 0; i < ranges.size(); i += 2) {
409 if (!android::base::WriteStringToFd(
Elliott Hughesbcabd092016-03-22 20:19:22 -0700410 android::base::StringPrintf("%d %d\n", ranges[i], ranges[i+1]), mapfd)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700411 PLOG(ERROR) << "failed to write " << tmp_map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700412 return kUncryptWriteError;
Tao Baofb4ccef2015-05-04 10:10:13 -0700413 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800414 }
415
Elliott Hughesbcabd092016-03-22 20:19:22 -0700416 if (fsync(mapfd) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700417 PLOG(ERROR) << "failed to fsync \"" << tmp_map_file << "\"";
Tianjie Xuda44cf12016-09-24 15:31:34 -0700418 return kUncryptFileSyncError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800419 }
Elliott Hughesbcabd092016-03-22 20:19:22 -0700420 if (close(mapfd.release()) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700421 PLOG(ERROR) << "failed to close " << tmp_map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700422 return kUncryptFileCloseError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800423 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800424
425 if (encrypted) {
Elliott Hughesbcabd092016-03-22 20:19:22 -0700426 if (fsync(wfd) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700427 PLOG(ERROR) << "failed to fsync \"" << blk_dev << "\"";
Tianjie Xuda44cf12016-09-24 15:31:34 -0700428 return kUncryptFileSyncError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800429 }
Elliott Hughesbcabd092016-03-22 20:19:22 -0700430 if (close(wfd.release()) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700431 PLOG(ERROR) << "failed to close " << blk_dev;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700432 return kUncryptFileCloseError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800433 }
Yabin Cui25dd0382016-02-01 11:40:37 -0800434 }
435
436 if (rename(tmp_map_file.c_str(), map_file) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700437 PLOG(ERROR) << "failed to rename " << tmp_map_file << " to " << map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700438 return kUncryptFileRenameError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800439 }
440 // Sync dir to make rename() result written to disk.
441 std::string file_name = map_file;
442 std::string dir_name = dirname(&file_name[0]);
Elliott Hughesbcabd092016-03-22 20:19:22 -0700443 android::base::unique_fd dfd(open(dir_name.c_str(), O_RDONLY | O_DIRECTORY));
444 if (dfd == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700445 PLOG(ERROR) << "failed to open dir " << dir_name;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700446 return kUncryptFileOpenError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800447 }
Elliott Hughesbcabd092016-03-22 20:19:22 -0700448 if (fsync(dfd) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700449 PLOG(ERROR) << "failed to fsync " << dir_name;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700450 return kUncryptFileSyncError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800451 }
Elliott Hughesbcabd092016-03-22 20:19:22 -0700452 if (close(dfd.release()) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700453 PLOG(ERROR) << "failed to close " << dir_name;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700454 return kUncryptFileCloseError;
Yabin Cui25dd0382016-02-01 11:40:37 -0800455 }
Doug Zongker76adfc52014-01-13 10:04:25 -0800456 return 0;
457}
458
Tao Bao3a2bb592016-02-25 12:38:53 -0800459static int uncrypt(const char* input_path, const char* map_file, const int socket) {
Tianjie Xu74778142016-08-05 18:00:04 -0700460 LOG(INFO) << "update package is \"" << input_path << "\"";
Doug Zongkerf449db22014-08-26 09:15:08 -0700461
Doug Zongker76adfc52014-01-13 10:04:25 -0800462 // Turn the name of the file we're supposed to convert into an
463 // absolute path, so we can find what filesystem it's on.
464 char path[PATH_MAX+1];
465 if (realpath(input_path, path) == NULL) {
Tianjie Xu74778142016-08-05 18:00:04 -0700466 PLOG(ERROR) << "failed to convert \"" << input_path << "\" to absolute path";
Doug Zongker76adfc52014-01-13 10:04:25 -0800467 return 1;
468 }
469
Tao Bao381f4552015-05-05 18:36:45 -0700470 bool encryptable;
471 bool encrypted;
Doug Zongker76adfc52014-01-13 10:04:25 -0800472 const char* blk_dev = find_block_device(path, &encryptable, &encrypted);
473 if (blk_dev == NULL) {
Tianjie Xu74778142016-08-05 18:00:04 -0700474 LOG(ERROR) << "failed to find block device for " << path;
Doug Zongker76adfc52014-01-13 10:04:25 -0800475 return 1;
476 }
477
478 // If the filesystem it's on isn't encrypted, we only produce the
479 // block map, we don't rewrite the file contents (it would be
480 // pointless to do so).
Tianjie Xu74778142016-08-05 18:00:04 -0700481 LOG(INFO) << "encryptable: " << (encryptable ? "yes" : "no");
482 LOG(INFO) << " encrypted: " << (encrypted ? "yes" : "no");
Doug Zongker76adfc52014-01-13 10:04:25 -0800483
Doug Zongker574443d2014-09-05 08:22:12 -0700484 // Recovery supports installing packages from 3 paths: /cache,
485 // /data, and /sdcard. (On a particular device, other locations
486 // may work, but those are three we actually expect.)
487 //
488 // On /data we want to convert the file to a block map so that we
489 // can read the package without mounting the partition. On /cache
490 // and /sdcard we leave the file alone.
Tao Bao383b00d2015-05-21 16:44:44 -0700491 if (strncmp(path, "/data/", 6) == 0) {
Tianjie Xu74778142016-08-05 18:00:04 -0700492 LOG(INFO) << "writing block map " << map_file;
Tianjie Xuda44cf12016-09-24 15:31:34 -0700493 return produce_block_map(path, map_file, blk_dev, encrypted, socket);
Tao Bao383b00d2015-05-21 16:44:44 -0700494 }
495
496 return 0;
497}
498
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700499static void log_uncrypt_error_code(UncryptErrorCode error_code) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700500 if (!android::base::WriteStringToFile(android::base::StringPrintf(
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700501 "uncrypt_error: %d\n", error_code), UNCRYPT_STATUS)) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700502 PLOG(WARNING) << "failed to write to " << UNCRYPT_STATUS;
503 }
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700504}
505
506static bool uncrypt_wrapper(const char* input_path, const char* map_file, const int socket) {
507 // Initialize the uncrypt error to kUncryptErrorPlaceholder.
508 log_uncrypt_error_code(kUncryptErrorPlaceholder);
Tianjie Xuda44cf12016-09-24 15:31:34 -0700509
Yabin Cui2d46da52016-01-26 16:50:15 -0800510 std::string package;
511 if (input_path == nullptr) {
512 if (!find_uncrypt_package(UNCRYPT_PATH_FILE, &package)) {
Tao Bao3a2bb592016-02-25 12:38:53 -0800513 write_status_to_socket(-1, socket);
Tianjie Xuda44cf12016-09-24 15:31:34 -0700514 // Overwrite the error message.
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700515 log_uncrypt_error_code(kUncryptPackageMissingError);
Tao Bao3a2bb592016-02-25 12:38:53 -0800516 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800517 }
518 input_path = package.c_str();
519 }
520 CHECK(map_file != nullptr);
Tianjie Xue16e7992016-09-09 10:55:44 -0700521
Tianjie Xue16e7992016-09-09 10:55:44 -0700522 auto start = std::chrono::system_clock::now();
Tao Bao3a2bb592016-02-25 12:38:53 -0800523 int status = uncrypt(input_path, map_file, socket);
Tianjie Xuda44cf12016-09-24 15:31:34 -0700524 std::chrono::duration<double> duration = std::chrono::system_clock::now() - start;
525 int count = static_cast<int>(duration.count());
526
527 std::string uncrypt_message = android::base::StringPrintf("uncrypt_time: %d\n", count);
Yabin Cui2d46da52016-01-26 16:50:15 -0800528 if (status != 0) {
Tianjie Xuda44cf12016-09-24 15:31:34 -0700529 // Log the time cost and error code if uncrypt fails.
530 uncrypt_message += android::base::StringPrintf("uncrypt_error: %d\n", status);
531 if (!android::base::WriteStringToFile(uncrypt_message, UNCRYPT_STATUS)) {
532 PLOG(WARNING) << "failed to write to " << UNCRYPT_STATUS;
533 }
534
Tao Bao3a2bb592016-02-25 12:38:53 -0800535 write_status_to_socket(-1, socket);
536 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800537 }
Tianjie Xue16e7992016-09-09 10:55:44 -0700538
Tianjie Xuda44cf12016-09-24 15:31:34 -0700539 if (!android::base::WriteStringToFile(uncrypt_message, UNCRYPT_STATUS)) {
Tianjie Xue16e7992016-09-09 10:55:44 -0700540 PLOG(WARNING) << "failed to write to " << UNCRYPT_STATUS;
541 }
542
Tao Bao3a2bb592016-02-25 12:38:53 -0800543 write_status_to_socket(100, socket);
Tianjie Xue16e7992016-09-09 10:55:44 -0700544
Tao Bao3a2bb592016-02-25 12:38:53 -0800545 return true;
Yabin Cui2d46da52016-01-26 16:50:15 -0800546}
547
Tao Bao3a2bb592016-02-25 12:38:53 -0800548static bool clear_bcb(const int socket) {
Yabin Cuia58a6db2016-04-06 15:52:18 -0700549 std::string err;
550 if (!clear_bootloader_message(&err)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700551 LOG(ERROR) << "failed to clear bootloader message: " << err;
Tao Bao3a2bb592016-02-25 12:38:53 -0800552 write_status_to_socket(-1, socket);
553 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800554 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800555 write_status_to_socket(100, socket);
556 return true;
Yabin Cui2d46da52016-01-26 16:50:15 -0800557}
558
Tao Bao3a2bb592016-02-25 12:38:53 -0800559static bool setup_bcb(const int socket) {
560 // c5. receive message length
561 int length;
562 if (!android::base::ReadFully(socket, &length, 4)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700563 PLOG(ERROR) << "failed to read the length";
Tao Bao3a2bb592016-02-25 12:38:53 -0800564 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800565 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800566 length = ntohl(length);
567
568 // c7. receive message
Yabin Cui2d46da52016-01-26 16:50:15 -0800569 std::string content;
Tao Bao3a2bb592016-02-25 12:38:53 -0800570 content.resize(length);
571 if (!android::base::ReadFully(socket, &content[0], length)) {
Tao Bao10334082016-12-12 17:10:20 -0800572 PLOG(ERROR) << "failed to read the message";
Tao Bao3a2bb592016-02-25 12:38:53 -0800573 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800574 }
Tianjie Xu74778142016-08-05 18:00:04 -0700575 LOG(INFO) << " received command: [" << content << "] (" << content.size() << ")";
Yabin Cui6faf0262016-06-09 14:09:39 -0700576 std::vector<std::string> options = android::base::Split(content, "\n");
577 std::string wipe_package;
578 for (auto& option : options) {
579 if (android::base::StartsWith(option, "--wipe_package=")) {
580 std::string path = option.substr(strlen("--wipe_package="));
581 if (!android::base::ReadFileToString(path, &wipe_package)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700582 PLOG(ERROR) << "failed to read " << path;
Yabin Cui6faf0262016-06-09 14:09:39 -0700583 return false;
584 }
585 option = android::base::StringPrintf("--wipe_package_size=%zu", wipe_package.size());
586 }
587 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800588
589 // c8. setup the bcb command
Yabin Cuia58a6db2016-04-06 15:52:18 -0700590 std::string err;
Yabin Cui6faf0262016-06-09 14:09:39 -0700591 if (!write_bootloader_message(options, &err)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700592 LOG(ERROR) << "failed to set bootloader message: " << err;
Tao Bao3a2bb592016-02-25 12:38:53 -0800593 write_status_to_socket(-1, socket);
594 return false;
Yabin Cui2d46da52016-01-26 16:50:15 -0800595 }
Yabin Cui6faf0262016-06-09 14:09:39 -0700596 if (!wipe_package.empty() && !write_wipe_package(wipe_package, &err)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700597 PLOG(ERROR) << "failed to set wipe package: " << err;
Yabin Cui6faf0262016-06-09 14:09:39 -0700598 write_status_to_socket(-1, socket);
599 return false;
600 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800601 // c10. send "100" status
602 write_status_to_socket(100, socket);
603 return true;
Yabin Cui2d46da52016-01-26 16:50:15 -0800604}
605
Yabin Cui2d46da52016-01-26 16:50:15 -0800606static void usage(const char* exename) {
607 fprintf(stderr, "Usage of %s:\n", exename);
608 fprintf(stderr, "%s [<package_path> <map_file>] Uncrypt ota package.\n", exename);
Yabin Cui2d46da52016-01-26 16:50:15 -0800609 fprintf(stderr, "%s --clear-bcb Clear BCB data in misc partition.\n", exename);
610 fprintf(stderr, "%s --setup-bcb Setup BCB data by command file.\n", exename);
Yabin Cui2d46da52016-01-26 16:50:15 -0800611}
612
613int main(int argc, char** argv) {
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700614 enum { UNCRYPT, SETUP_BCB, CLEAR_BCB, UNCRYPT_DEBUG } action;
Tao Bao3a2bb592016-02-25 12:38:53 -0800615 const char* input_path = nullptr;
616 const char* map_file = CACHE_BLOCK_MAP.c_str();
617
618 if (argc == 2 && strcmp(argv[1], "--clear-bcb") == 0) {
619 action = CLEAR_BCB;
620 } else if (argc == 2 && strcmp(argv[1], "--setup-bcb") == 0) {
621 action = SETUP_BCB;
Tao Bao3a2bb592016-02-25 12:38:53 -0800622 } else if (argc == 1) {
623 action = UNCRYPT;
624 } else if (argc == 3) {
625 input_path = argv[1];
626 map_file = argv[2];
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700627 action = UNCRYPT_DEBUG;
Tao Bao3a2bb592016-02-25 12:38:53 -0800628 } else {
629 usage(argv[0]);
630 return 2;
Doug Zongker76adfc52014-01-13 10:04:25 -0800631 }
Tao Bao3a2bb592016-02-25 12:38:53 -0800632
633 if ((fstab = read_fstab()) == nullptr) {
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700634 log_uncrypt_error_code(kUncryptFstabReadError);
Tao Bao3a2bb592016-02-25 12:38:53 -0800635 return 1;
636 }
637
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700638 if (action == UNCRYPT_DEBUG) {
Tianjie Xu74778142016-08-05 18:00:04 -0700639 LOG(INFO) << "uncrypt called in debug mode, skip socket communication";
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700640 bool success = uncrypt_wrapper(input_path, map_file, -1);
641 if (success) {
Tianjie Xu74778142016-08-05 18:00:04 -0700642 LOG(INFO) << "uncrypt succeeded";
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700643 } else{
Tianjie Xu74778142016-08-05 18:00:04 -0700644 LOG(INFO) << "uncrypt failed";
Tianjie Xu28c1e5d2016-06-30 15:31:51 -0700645 }
646 return success ? 0 : 1;
647 }
648
Tao Bao3a2bb592016-02-25 12:38:53 -0800649 // c3. The socket is created by init when starting the service. uncrypt
650 // will use the socket to communicate with its caller.
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700651 android::base::unique_fd service_socket(android_get_control_socket(UNCRYPT_SOCKET.c_str()));
652 if (service_socket == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700653 PLOG(ERROR) << "failed to open socket \"" << UNCRYPT_SOCKET << "\"";
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700654 log_uncrypt_error_code(kUncryptSocketOpenError);
Tao Bao3a2bb592016-02-25 12:38:53 -0800655 return 1;
656 }
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700657 fcntl(service_socket, F_SETFD, FD_CLOEXEC);
Tao Bao3a2bb592016-02-25 12:38:53 -0800658
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700659 if (listen(service_socket, 1) == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700660 PLOG(ERROR) << "failed to listen on socket " << service_socket.get();
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700661 log_uncrypt_error_code(kUncryptSocketListenError);
Tao Bao3a2bb592016-02-25 12:38:53 -0800662 return 1;
663 }
664
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700665 android::base::unique_fd socket_fd(accept4(service_socket, nullptr, nullptr, SOCK_CLOEXEC));
666 if (socket_fd == -1) {
Tianjie Xu74778142016-08-05 18:00:04 -0700667 PLOG(ERROR) << "failed to accept on socket " << service_socket.get();
Tianjie Xu68fc81e2016-09-24 15:31:34 -0700668 log_uncrypt_error_code(kUncryptSocketAcceptError);
Tao Bao3a2bb592016-02-25 12:38:53 -0800669 return 1;
670 }
671
672 bool success = false;
673 switch (action) {
674 case UNCRYPT:
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700675 success = uncrypt_wrapper(input_path, map_file, socket_fd);
Tao Bao3a2bb592016-02-25 12:38:53 -0800676 break;
677 case SETUP_BCB:
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700678 success = setup_bcb(socket_fd);
Tao Bao3a2bb592016-02-25 12:38:53 -0800679 break;
680 case CLEAR_BCB:
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700681 success = clear_bcb(socket_fd);
Tao Bao3a2bb592016-02-25 12:38:53 -0800682 break;
683 default: // Should never happen.
Tianjie Xu74778142016-08-05 18:00:04 -0700684 LOG(ERROR) << "Invalid uncrypt action code: " << action;
Tao Bao3a2bb592016-02-25 12:38:53 -0800685 return 1;
686 }
687
688 // c13. Read a 4-byte code from the client before uncrypt exits. This is to
689 // ensure the client to receive the last status code before the socket gets
690 // destroyed.
691 int code;
Elliott Hughesd6ac6862016-03-29 12:44:09 -0700692 if (android::base::ReadFully(socket_fd, &code, 4)) {
Tianjie Xu74778142016-08-05 18:00:04 -0700693 LOG(INFO) << " received " << code << ", exiting now";
Tao Bao3a2bb592016-02-25 12:38:53 -0800694 } else {
Tianjie Xu74778142016-08-05 18:00:04 -0700695 PLOG(ERROR) << "failed to read the code";
Tao Bao3a2bb592016-02-25 12:38:53 -0800696 }
697 return success ? 0 : 1;
Doug Zongker76adfc52014-01-13 10:04:25 -0800698}