blob: 7b8a010e31321a273932a3a4fc0aa19f361f9414 [file] [log] [blame]
Doug Zongker512536a2010-02-17 16:11:44 -08001/*
2 * Copyright (C) 2008 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#include <errno.h>
18#include <libgen.h>
19#include <stdio.h>
20#include <stdlib.h>
21#include <string.h>
22#include <sys/stat.h>
23#include <sys/statfs.h>
24#include <sys/types.h>
25#include <fcntl.h>
26#include <unistd.h>
27
28#include "mincrypt/sha.h"
29#include "applypatch.h"
30#include "mtdutils/mtdutils.h"
Doug Zongkerc4351c72010-02-22 14:46:32 -080031#include "edify/expr.h"
Doug Zongker512536a2010-02-17 16:11:44 -080032
Doug Zongkerf291d852010-07-07 13:55:25 -070033static int LoadPartitionContents(const char* filename, FileContents* file);
Doug Zongkerf291d852010-07-07 13:55:25 -070034static ssize_t FileSink(unsigned char* data, ssize_t len, void* token);
Doug Zongker1c43c972012-02-28 11:07:09 -080035static int GenerateTarget(FileContents* source_file,
36 const Value* source_patch_value,
37 FileContents* copy_file,
38 const Value* copy_patch_value,
39 const char* source_filename,
40 const char* target_filename,
41 const uint8_t target_sha1[SHA_DIGEST_SIZE],
Doug Zongkera3ccba62012-08-20 15:28:02 -070042 size_t target_size,
43 const Value* bonus_data);
Doug Zongker512536a2010-02-17 16:11:44 -080044
45static int mtd_partitions_scanned = 0;
46
Hristo Bojinovdb314d62010-08-02 10:29:49 -070047// Read a file into memory; optionally (retouch_flag == RETOUCH_DO_MASK) mask
48// the retouched entries back to their original value (such that SHA-1 checks
49// don't fail due to randomization); store the file contents and associated
50// metadata in *file.
51//
52// Return 0 on success.
53int LoadFileContents(const char* filename, FileContents* file,
54 int retouch_flag) {
Doug Zongker512536a2010-02-17 16:11:44 -080055 file->data = NULL;
Doug Zongker512536a2010-02-17 16:11:44 -080056
Doug Zongkerf291d852010-07-07 13:55:25 -070057 // A special 'filename' beginning with "MTD:" or "EMMC:" means to
58 // load the contents of a partition.
59 if (strncmp(filename, "MTD:", 4) == 0 ||
60 strncmp(filename, "EMMC:", 5) == 0) {
61 return LoadPartitionContents(filename, file);
Doug Zongkerc4351c72010-02-22 14:46:32 -080062 }
Doug Zongker512536a2010-02-17 16:11:44 -080063
Doug Zongkerc4351c72010-02-22 14:46:32 -080064 if (stat(filename, &file->st) != 0) {
65 printf("failed to stat \"%s\": %s\n", filename, strerror(errno));
66 return -1;
67 }
68
69 file->size = file->st.st_size;
70 file->data = malloc(file->size);
71
72 FILE* f = fopen(filename, "rb");
73 if (f == NULL) {
74 printf("failed to open \"%s\": %s\n", filename, strerror(errno));
75 free(file->data);
76 file->data = NULL;
77 return -1;
78 }
79
80 ssize_t bytes_read = fread(file->data, 1, file->size, f);
81 if (bytes_read != file->size) {
82 printf("short read of \"%s\" (%ld bytes of %ld)\n",
83 filename, (long)bytes_read, (long)file->size);
84 free(file->data);
85 file->data = NULL;
86 return -1;
87 }
88 fclose(f);
89
Hristo Bojinovdb314d62010-08-02 10:29:49 -070090 // apply_patch[_check] functions are blind to randomization. Randomization
91 // is taken care of in [Undo]RetouchBinariesFn. If there is a mismatch
92 // within a file, this means the file is assumed "corrupt" for simplicity.
93 if (retouch_flag) {
94 int32_t desired_offset = 0;
95 if (retouch_mask_data(file->data, file->size,
96 &desired_offset, NULL) != RETOUCH_DATA_MATCHED) {
97 printf("error trying to mask retouch entries\n");
98 free(file->data);
99 file->data = NULL;
100 return -1;
101 }
102 }
103
Doug Zongkerc4351c72010-02-22 14:46:32 -0800104 SHA(file->data, file->size, file->sha1);
105 return 0;
Doug Zongker512536a2010-02-17 16:11:44 -0800106}
107
108static size_t* size_array;
109// comparison function for qsort()ing an int array of indexes into
110// size_array[].
111static int compare_size_indices(const void* a, const void* b) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800112 int aa = *(int*)a;
113 int bb = *(int*)b;
114 if (size_array[aa] < size_array[bb]) {
115 return -1;
116 } else if (size_array[aa] > size_array[bb]) {
117 return 1;
118 } else {
119 return 0;
120 }
Doug Zongker512536a2010-02-17 16:11:44 -0800121}
122
Doug Zongkerf291d852010-07-07 13:55:25 -0700123// Load the contents of an MTD or EMMC partition into the provided
Doug Zongker512536a2010-02-17 16:11:44 -0800124// FileContents. filename should be a string of the form
Doug Zongkerf291d852010-07-07 13:55:25 -0700125// "MTD:<partition_name>:<size_1>:<sha1_1>:<size_2>:<sha1_2>:..." (or
126// "EMMC:<partition_device>:..."). The smallest size_n bytes for
127// which that prefix of the partition contents has the corresponding
128// sha1 hash will be loaded. It is acceptable for a size value to be
129// repeated with different sha1s. Will return 0 on success.
Doug Zongker512536a2010-02-17 16:11:44 -0800130//
131// This complexity is needed because if an OTA installation is
132// interrupted, the partition might contain either the source or the
133// target data, which might be of different lengths. We need to know
Doug Zongkerf291d852010-07-07 13:55:25 -0700134// the length in order to read from a partition (there is no
135// "end-of-file" marker), so the caller must specify the possible
136// lengths and the hash of the data, and we'll do the load expecting
137// to find one of those hashes.
138enum PartitionType { MTD, EMMC };
139
140static int LoadPartitionContents(const char* filename, FileContents* file) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800141 char* copy = strdup(filename);
142 const char* magic = strtok(copy, ":");
Doug Zongkerf291d852010-07-07 13:55:25 -0700143
144 enum PartitionType type;
145
146 if (strcmp(magic, "MTD") == 0) {
147 type = MTD;
148 } else if (strcmp(magic, "EMMC") == 0) {
149 type = EMMC;
150 } else {
151 printf("LoadPartitionContents called with bad filename (%s)\n",
Doug Zongkerc4351c72010-02-22 14:46:32 -0800152 filename);
153 return -1;
Doug Zongker512536a2010-02-17 16:11:44 -0800154 }
Doug Zongkerc4351c72010-02-22 14:46:32 -0800155 const char* partition = strtok(NULL, ":");
Doug Zongker512536a2010-02-17 16:11:44 -0800156
Doug Zongkerc4351c72010-02-22 14:46:32 -0800157 int i;
158 int colons = 0;
159 for (i = 0; filename[i] != '\0'; ++i) {
160 if (filename[i] == ':') {
161 ++colons;
162 }
Doug Zongker512536a2010-02-17 16:11:44 -0800163 }
Doug Zongkerc4351c72010-02-22 14:46:32 -0800164 if (colons < 3 || colons%2 == 0) {
Doug Zongkerf291d852010-07-07 13:55:25 -0700165 printf("LoadPartitionContents called with bad filename (%s)\n",
Doug Zongkerc4351c72010-02-22 14:46:32 -0800166 filename);
167 }
Doug Zongker512536a2010-02-17 16:11:44 -0800168
Doug Zongkerc4351c72010-02-22 14:46:32 -0800169 int pairs = (colons-1)/2; // # of (size,sha1) pairs in filename
170 int* index = malloc(pairs * sizeof(int));
171 size_t* size = malloc(pairs * sizeof(size_t));
172 char** sha1sum = malloc(pairs * sizeof(char*));
Doug Zongker512536a2010-02-17 16:11:44 -0800173
Doug Zongkerc4351c72010-02-22 14:46:32 -0800174 for (i = 0; i < pairs; ++i) {
175 const char* size_str = strtok(NULL, ":");
176 size[i] = strtol(size_str, NULL, 10);
177 if (size[i] == 0) {
Doug Zongkerf291d852010-07-07 13:55:25 -0700178 printf("LoadPartitionContents called with bad size (%s)\n", filename);
Doug Zongkerc4351c72010-02-22 14:46:32 -0800179 return -1;
180 }
181 sha1sum[i] = strtok(NULL, ":");
182 index[i] = i;
183 }
Doug Zongker512536a2010-02-17 16:11:44 -0800184
Doug Zongkerc4351c72010-02-22 14:46:32 -0800185 // sort the index[] array so it indexes the pairs in order of
186 // increasing size.
187 size_array = size;
188 qsort(index, pairs, sizeof(int), compare_size_indices);
Doug Zongker512536a2010-02-17 16:11:44 -0800189
Doug Zongkerf291d852010-07-07 13:55:25 -0700190 MtdReadContext* ctx = NULL;
191 FILE* dev = NULL;
Doug Zongker512536a2010-02-17 16:11:44 -0800192
Doug Zongkerf291d852010-07-07 13:55:25 -0700193 switch (type) {
194 case MTD:
195 if (!mtd_partitions_scanned) {
196 mtd_scan_partitions();
197 mtd_partitions_scanned = 1;
198 }
Doug Zongker512536a2010-02-17 16:11:44 -0800199
Doug Zongkerf291d852010-07-07 13:55:25 -0700200 const MtdPartition* mtd = mtd_find_partition_by_name(partition);
201 if (mtd == NULL) {
202 printf("mtd partition \"%s\" not found (loading %s)\n",
203 partition, filename);
204 return -1;
205 }
206
207 ctx = mtd_read_partition(mtd);
208 if (ctx == NULL) {
209 printf("failed to initialize read of mtd partition \"%s\"\n",
210 partition);
211 return -1;
212 }
213 break;
214
215 case EMMC:
216 dev = fopen(partition, "rb");
217 if (dev == NULL) {
218 printf("failed to open emmc partition \"%s\": %s\n",
219 partition, strerror(errno));
220 return -1;
221 }
Doug Zongkerc4351c72010-02-22 14:46:32 -0800222 }
Doug Zongker512536a2010-02-17 16:11:44 -0800223
Doug Zongkerc4351c72010-02-22 14:46:32 -0800224 SHA_CTX sha_ctx;
225 SHA_init(&sha_ctx);
226 uint8_t parsed_sha[SHA_DIGEST_SIZE];
227
228 // allocate enough memory to hold the largest size.
229 file->data = malloc(size[index[pairs-1]]);
230 char* p = (char*)file->data;
231 file->size = 0; // # bytes read so far
232
233 for (i = 0; i < pairs; ++i) {
234 // Read enough additional bytes to get us up to the next size
235 // (again, we're trying the possibilities in order of increasing
236 // size).
237 size_t next = size[index[i]] - file->size;
238 size_t read = 0;
239 if (next > 0) {
Doug Zongkerf291d852010-07-07 13:55:25 -0700240 switch (type) {
241 case MTD:
242 read = mtd_read_data(ctx, p, next);
243 break;
244
245 case EMMC:
246 read = fread(p, 1, next, dev);
247 break;
248 }
Doug Zongkerc4351c72010-02-22 14:46:32 -0800249 if (next != read) {
250 printf("short read (%d bytes of %d) for partition \"%s\"\n",
251 read, next, partition);
252 free(file->data);
253 file->data = NULL;
254 return -1;
255 }
256 SHA_update(&sha_ctx, p, read);
257 file->size += read;
258 }
259
260 // Duplicate the SHA context and finalize the duplicate so we can
261 // check it against this pair's expected hash.
262 SHA_CTX temp_ctx;
263 memcpy(&temp_ctx, &sha_ctx, sizeof(SHA_CTX));
264 const uint8_t* sha_so_far = SHA_final(&temp_ctx);
265
266 if (ParseSha1(sha1sum[index[i]], parsed_sha) != 0) {
267 printf("failed to parse sha1 %s in %s\n",
268 sha1sum[index[i]], filename);
269 free(file->data);
270 file->data = NULL;
271 return -1;
272 }
273
274 if (memcmp(sha_so_far, parsed_sha, SHA_DIGEST_SIZE) == 0) {
275 // we have a match. stop reading the partition; we'll return
276 // the data we've read so far.
Doug Zongkerf291d852010-07-07 13:55:25 -0700277 printf("partition read matched size %d sha %s\n",
Doug Zongkerc4351c72010-02-22 14:46:32 -0800278 size[index[i]], sha1sum[index[i]]);
279 break;
280 }
281
282 p += read;
283 }
284
Doug Zongkerf291d852010-07-07 13:55:25 -0700285 switch (type) {
286 case MTD:
287 mtd_read_close(ctx);
288 break;
289
290 case EMMC:
291 fclose(dev);
292 break;
293 }
294
Doug Zongkerc4351c72010-02-22 14:46:32 -0800295
296 if (i == pairs) {
297 // Ran off the end of the list of (size,sha1) pairs without
298 // finding a match.
Doug Zongkerf291d852010-07-07 13:55:25 -0700299 printf("contents of partition \"%s\" didn't match %s\n",
Doug Zongkerc4351c72010-02-22 14:46:32 -0800300 partition, filename);
Doug Zongker512536a2010-02-17 16:11:44 -0800301 free(file->data);
302 file->data = NULL;
303 return -1;
Doug Zongker512536a2010-02-17 16:11:44 -0800304 }
305
Doug Zongkerc4351c72010-02-22 14:46:32 -0800306 const uint8_t* sha_final = SHA_final(&sha_ctx);
307 for (i = 0; i < SHA_DIGEST_SIZE; ++i) {
308 file->sha1[i] = sha_final[i];
Doug Zongker512536a2010-02-17 16:11:44 -0800309 }
310
Doug Zongkerc4351c72010-02-22 14:46:32 -0800311 // Fake some stat() info.
312 file->st.st_mode = 0644;
313 file->st.st_uid = 0;
314 file->st.st_gid = 0;
Doug Zongker512536a2010-02-17 16:11:44 -0800315
Doug Zongkerc4351c72010-02-22 14:46:32 -0800316 free(copy);
317 free(index);
318 free(size);
319 free(sha1sum);
Doug Zongker512536a2010-02-17 16:11:44 -0800320
Doug Zongkerc4351c72010-02-22 14:46:32 -0800321 return 0;
Doug Zongker512536a2010-02-17 16:11:44 -0800322}
323
324
325// Save the contents of the given FileContents object under the given
326// filename. Return 0 on success.
Doug Zongker1c43c972012-02-28 11:07:09 -0800327int SaveFileContents(const char* filename, const FileContents* file) {
Nick Kralevich956cde82012-06-26 15:01:03 -0700328 int fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
Doug Zongkerc4351c72010-02-22 14:46:32 -0800329 if (fd < 0) {
330 printf("failed to open \"%s\" for write: %s\n",
331 filename, strerror(errno));
332 return -1;
333 }
Doug Zongker512536a2010-02-17 16:11:44 -0800334
Doug Zongker1c43c972012-02-28 11:07:09 -0800335 ssize_t bytes_written = FileSink(file->data, file->size, &fd);
336 if (bytes_written != file->size) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800337 printf("short write of \"%s\" (%ld bytes of %ld) (%s)\n",
Doug Zongker1c43c972012-02-28 11:07:09 -0800338 filename, (long)bytes_written, (long)file->size,
Doug Zongkerc4351c72010-02-22 14:46:32 -0800339 strerror(errno));
340 close(fd);
341 return -1;
342 }
343 fsync(fd);
Doug Zongker512536a2010-02-17 16:11:44 -0800344 close(fd);
Doug Zongker512536a2010-02-17 16:11:44 -0800345
Doug Zongker1c43c972012-02-28 11:07:09 -0800346 if (chmod(filename, file->st.st_mode) != 0) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800347 printf("chmod of \"%s\" failed: %s\n", filename, strerror(errno));
348 return -1;
349 }
Doug Zongker1c43c972012-02-28 11:07:09 -0800350 if (chown(filename, file->st.st_uid, file->st.st_gid) != 0) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800351 printf("chown of \"%s\" failed: %s\n", filename, strerror(errno));
352 return -1;
353 }
Doug Zongker512536a2010-02-17 16:11:44 -0800354
Doug Zongkerc4351c72010-02-22 14:46:32 -0800355 return 0;
Doug Zongker512536a2010-02-17 16:11:44 -0800356}
357
Doug Zongkerf291d852010-07-07 13:55:25 -0700358// Write a memory buffer to 'target' partition, a string of the form
359// "MTD:<partition>[:...]" or "EMMC:<partition_device>:". Return 0 on
360// success.
361int WriteToPartition(unsigned char* data, size_t len,
362 const char* target) {
363 char* copy = strdup(target);
364 const char* magic = strtok(copy, ":");
365
366 enum PartitionType type;
367 if (strcmp(magic, "MTD") == 0) {
368 type = MTD;
369 } else if (strcmp(magic, "EMMC") == 0) {
370 type = EMMC;
371 } else {
372 printf("WriteToPartition called with bad target (%s)\n", target);
373 return -1;
374 }
375 const char* partition = strtok(NULL, ":");
376
Doug Zongkerc4351c72010-02-22 14:46:32 -0800377 if (partition == NULL) {
Doug Zongkerf291d852010-07-07 13:55:25 -0700378 printf("bad partition target name \"%s\"\n", target);
Doug Zongkerc4351c72010-02-22 14:46:32 -0800379 return -1;
380 }
Doug Zongker512536a2010-02-17 16:11:44 -0800381
Doug Zongkerf291d852010-07-07 13:55:25 -0700382 switch (type) {
383 case MTD:
384 if (!mtd_partitions_scanned) {
385 mtd_scan_partitions();
386 mtd_partitions_scanned = 1;
387 }
388
389 const MtdPartition* mtd = mtd_find_partition_by_name(partition);
390 if (mtd == NULL) {
391 printf("mtd partition \"%s\" not found for writing\n",
392 partition);
393 return -1;
394 }
395
396 MtdWriteContext* ctx = mtd_write_partition(mtd);
397 if (ctx == NULL) {
398 printf("failed to init mtd partition \"%s\" for writing\n",
399 partition);
400 return -1;
401 }
402
403 size_t written = mtd_write_data(ctx, (char*)data, len);
404 if (written != len) {
405 printf("only wrote %d of %d bytes to MTD %s\n",
406 written, len, partition);
407 mtd_write_close(ctx);
408 return -1;
409 }
410
411 if (mtd_erase_blocks(ctx, -1) < 0) {
412 printf("error finishing mtd write of %s\n", partition);
413 mtd_write_close(ctx);
414 return -1;
415 }
416
417 if (mtd_write_close(ctx)) {
418 printf("error closing mtd write of %s\n", partition);
419 return -1;
420 }
421 break;
422
423 case EMMC:
424 ;
425 FILE* f = fopen(partition, "wb");
426 if (fwrite(data, 1, len, f) != len) {
427 printf("short write writing to %s (%s)\n",
428 partition, strerror(errno));
429 return -1;
430 }
431 if (fclose(f) != 0) {
432 printf("error closing %s (%s)\n", partition, strerror(errno));
433 return -1;
434 }
435 break;
Doug Zongkerc4351c72010-02-22 14:46:32 -0800436 }
Doug Zongker512536a2010-02-17 16:11:44 -0800437
Doug Zongkerf291d852010-07-07 13:55:25 -0700438 free(copy);
Doug Zongkerc4351c72010-02-22 14:46:32 -0800439 return 0;
Doug Zongker512536a2010-02-17 16:11:44 -0800440}
441
442
443// Take a string 'str' of 40 hex digits and parse it into the 20
444// byte array 'digest'. 'str' may contain only the digest or be of
445// the form "<digest>:<anything>". Return 0 on success, -1 on any
446// error.
447int ParseSha1(const char* str, uint8_t* digest) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800448 int i;
449 const char* ps = str;
450 uint8_t* pd = digest;
451 for (i = 0; i < SHA_DIGEST_SIZE * 2; ++i, ++ps) {
452 int digit;
453 if (*ps >= '0' && *ps <= '9') {
454 digit = *ps - '0';
455 } else if (*ps >= 'a' && *ps <= 'f') {
456 digit = *ps - 'a' + 10;
457 } else if (*ps >= 'A' && *ps <= 'F') {
458 digit = *ps - 'A' + 10;
459 } else {
460 return -1;
461 }
462 if (i % 2 == 0) {
463 *pd = digit << 4;
464 } else {
465 *pd |= digit;
466 ++pd;
467 }
Doug Zongker512536a2010-02-17 16:11:44 -0800468 }
Doug Zongkerc4351c72010-02-22 14:46:32 -0800469 if (*ps != '\0') return -1;
470 return 0;
Doug Zongker512536a2010-02-17 16:11:44 -0800471}
472
Doug Zongkerc4351c72010-02-22 14:46:32 -0800473// Search an array of sha1 strings for one matching the given sha1.
474// Return the index of the match on success, or -1 if no match is
475// found.
Doug Zongkerb07b2932012-02-28 12:07:30 -0800476int FindMatchingPatch(uint8_t* sha1, const char** patch_sha1_str,
Doug Zongkerc4351c72010-02-22 14:46:32 -0800477 int num_patches) {
478 int i;
479 uint8_t patch_sha1[SHA_DIGEST_SIZE];
480 for (i = 0; i < num_patches; ++i) {
481 if (ParseSha1(patch_sha1_str[i], patch_sha1) == 0 &&
482 memcmp(patch_sha1, sha1, SHA_DIGEST_SIZE) == 0) {
483 return i;
484 }
Doug Zongker512536a2010-02-17 16:11:44 -0800485 }
Doug Zongkerc4351c72010-02-22 14:46:32 -0800486 return -1;
Doug Zongker512536a2010-02-17 16:11:44 -0800487}
488
489// Returns 0 if the contents of the file (argv[2]) or the cached file
490// match any of the sha1's on the command line (argv[3:]). Returns
491// nonzero otherwise.
Doug Zongkerc4351c72010-02-22 14:46:32 -0800492int applypatch_check(const char* filename,
493 int num_patches, char** const patch_sha1_str) {
494 FileContents file;
495 file.data = NULL;
Doug Zongker512536a2010-02-17 16:11:44 -0800496
Doug Zongkerc4351c72010-02-22 14:46:32 -0800497 // It's okay to specify no sha1s; the check will pass if the
Doug Zongkerf291d852010-07-07 13:55:25 -0700498 // LoadFileContents is successful. (Useful for reading
Doug Zongkerc4351c72010-02-22 14:46:32 -0800499 // partitions, where the filename encodes the sha1s; no need to
500 // check them twice.)
Hristo Bojinovdb314d62010-08-02 10:29:49 -0700501 if (LoadFileContents(filename, &file, RETOUCH_DO_MASK) != 0 ||
Doug Zongkerc4351c72010-02-22 14:46:32 -0800502 (num_patches > 0 &&
503 FindMatchingPatch(file.sha1, patch_sha1_str, num_patches) < 0)) {
504 printf("file \"%s\" doesn't have any of expected "
505 "sha1 sums; checking cache\n", filename);
Doug Zongker512536a2010-02-17 16:11:44 -0800506
Doug Zongkerc4351c72010-02-22 14:46:32 -0800507 free(file.data);
Doug Zongker1c43c972012-02-28 11:07:09 -0800508 file.data = NULL;
Doug Zongker512536a2010-02-17 16:11:44 -0800509
Doug Zongkerc4351c72010-02-22 14:46:32 -0800510 // If the source file is missing or corrupted, it might be because
511 // we were killed in the middle of patching it. A copy of it
512 // should have been made in CACHE_TEMP_SOURCE. If that file
513 // exists and matches the sha1 we're looking for, the check still
514 // passes.
515
Hristo Bojinovdb314d62010-08-02 10:29:49 -0700516 if (LoadFileContents(CACHE_TEMP_SOURCE, &file, RETOUCH_DO_MASK) != 0) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800517 printf("failed to load cache file\n");
518 return 1;
519 }
520
521 if (FindMatchingPatch(file.sha1, patch_sha1_str, num_patches) < 0) {
522 printf("cache bits don't match any sha1 for \"%s\"\n", filename);
523 free(file.data);
524 return 1;
525 }
526 }
Doug Zongker512536a2010-02-17 16:11:44 -0800527
528 free(file.data);
Doug Zongkerc4351c72010-02-22 14:46:32 -0800529 return 0;
Doug Zongker512536a2010-02-17 16:11:44 -0800530}
531
532int ShowLicenses() {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800533 ShowBSDiffLicense();
534 return 0;
Doug Zongker512536a2010-02-17 16:11:44 -0800535}
536
537ssize_t FileSink(unsigned char* data, ssize_t len, void* token) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800538 int fd = *(int *)token;
539 ssize_t done = 0;
540 ssize_t wrote;
541 while (done < (ssize_t) len) {
542 wrote = write(fd, data+done, len-done);
543 if (wrote <= 0) {
544 printf("error writing %d bytes: %s\n", (int)(len-done), strerror(errno));
545 return done;
546 }
547 done += wrote;
Doug Zongker512536a2010-02-17 16:11:44 -0800548 }
Doug Zongkerc4351c72010-02-22 14:46:32 -0800549 return done;
Doug Zongker512536a2010-02-17 16:11:44 -0800550}
551
552typedef struct {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800553 unsigned char* buffer;
554 ssize_t size;
555 ssize_t pos;
Doug Zongker512536a2010-02-17 16:11:44 -0800556} MemorySinkInfo;
557
558ssize_t MemorySink(unsigned char* data, ssize_t len, void* token) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800559 MemorySinkInfo* msi = (MemorySinkInfo*)token;
560 if (msi->size - msi->pos < len) {
561 return -1;
562 }
563 memcpy(msi->buffer + msi->pos, data, len);
564 msi->pos += len;
565 return len;
Doug Zongker512536a2010-02-17 16:11:44 -0800566}
567
568// Return the amount of free space (in bytes) on the filesystem
569// containing filename. filename must exist. Return -1 on error.
570size_t FreeSpaceForFile(const char* filename) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800571 struct statfs sf;
572 if (statfs(filename, &sf) != 0) {
573 printf("failed to statfs %s: %s\n", filename, strerror(errno));
574 return -1;
575 }
576 return sf.f_bsize * sf.f_bfree;
Doug Zongker512536a2010-02-17 16:11:44 -0800577}
578
Doug Zongkerc4351c72010-02-22 14:46:32 -0800579int CacheSizeCheck(size_t bytes) {
580 if (MakeFreeSpaceOnCache(bytes) < 0) {
581 printf("unable to make %ld bytes available on /cache\n", (long)bytes);
582 return 1;
583 } else {
584 return 0;
585 }
586}
587
588
589// This function applies binary patches to files in a way that is safe
Doug Zongker512536a2010-02-17 16:11:44 -0800590// (the original file is not touched until we have the desired
591// replacement for it) and idempotent (it's okay to run this program
592// multiple times).
593//
Doug Zongkerc4351c72010-02-22 14:46:32 -0800594// - if the sha1 hash of <target_filename> is <target_sha1_string>,
595// does nothing and exits successfully.
Doug Zongker512536a2010-02-17 16:11:44 -0800596//
Doug Zongkerc4351c72010-02-22 14:46:32 -0800597// - otherwise, if the sha1 hash of <source_filename> is one of the
598// entries in <patch_sha1_str>, the corresponding patch from
599// <patch_data> (which must be a VAL_BLOB) is applied to produce a
600// new file (the type of patch is automatically detected from the
601// blob daat). If that new file has sha1 hash <target_sha1_str>,
602// moves it to replace <target_filename>, and exits successfully.
603// Note that if <source_filename> and <target_filename> are not the
604// same, <source_filename> is NOT deleted on success.
605// <target_filename> may be the string "-" to mean "the same as
606// source_filename".
Doug Zongker512536a2010-02-17 16:11:44 -0800607//
608// - otherwise, or if any error is encountered, exits with non-zero
609// status.
610//
Doug Zongkerf291d852010-07-07 13:55:25 -0700611// <source_filename> may refer to a partition to read the source data.
612// See the comments for the LoadPartition Contents() function above
Doug Zongkerc4351c72010-02-22 14:46:32 -0800613// for the format of such a filename.
Doug Zongker512536a2010-02-17 16:11:44 -0800614
Doug Zongkerc4351c72010-02-22 14:46:32 -0800615int applypatch(const char* source_filename,
616 const char* target_filename,
617 const char* target_sha1_str,
618 size_t target_size,
619 int num_patches,
620 char** const patch_sha1_str,
Doug Zongkera3ccba62012-08-20 15:28:02 -0700621 Value** patch_data,
622 Value* bonus_data) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800623 printf("\napplying patch to %s\n", source_filename);
Doug Zongker512536a2010-02-17 16:11:44 -0800624
Doug Zongkerc4351c72010-02-22 14:46:32 -0800625 if (target_filename[0] == '-' &&
626 target_filename[1] == '\0') {
627 target_filename = source_filename;
Doug Zongker512536a2010-02-17 16:11:44 -0800628 }
629
Doug Zongkerc4351c72010-02-22 14:46:32 -0800630 uint8_t target_sha1[SHA_DIGEST_SIZE];
631 if (ParseSha1(target_sha1_str, target_sha1) != 0) {
632 printf("failed to parse tgt-sha1 \"%s\"\n", target_sha1_str);
Doug Zongker512536a2010-02-17 16:11:44 -0800633 return 1;
Doug Zongkerc4351c72010-02-22 14:46:32 -0800634 }
Doug Zongker512536a2010-02-17 16:11:44 -0800635
Doug Zongkerc4351c72010-02-22 14:46:32 -0800636 FileContents copy_file;
637 FileContents source_file;
Doug Zongker1c43c972012-02-28 11:07:09 -0800638 copy_file.data = NULL;
639 source_file.data = NULL;
Doug Zongkerc4351c72010-02-22 14:46:32 -0800640 const Value* source_patch_value = NULL;
641 const Value* copy_patch_value = NULL;
Doug Zongker512536a2010-02-17 16:11:44 -0800642
Doug Zongkerc4351c72010-02-22 14:46:32 -0800643 // We try to load the target file into the source_file object.
Hristo Bojinovdb314d62010-08-02 10:29:49 -0700644 if (LoadFileContents(target_filename, &source_file,
645 RETOUCH_DO_MASK) == 0) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800646 if (memcmp(source_file.sha1, target_sha1, SHA_DIGEST_SIZE) == 0) {
647 // The early-exit case: the patch was already applied, this file
648 // has the desired hash, nothing for us to do.
649 printf("\"%s\" is already target; no patch needed\n",
650 target_filename);
Doug Zongker1c43c972012-02-28 11:07:09 -0800651 free(source_file.data);
Doug Zongkerc4351c72010-02-22 14:46:32 -0800652 return 0;
653 }
654 }
Doug Zongker512536a2010-02-17 16:11:44 -0800655
Doug Zongkerc4351c72010-02-22 14:46:32 -0800656 if (source_file.data == NULL ||
657 (target_filename != source_filename &&
658 strcmp(target_filename, source_filename) != 0)) {
659 // Need to load the source file: either we failed to load the
660 // target file, or we did but it's different from the source file.
661 free(source_file.data);
Doug Zongker1c43c972012-02-28 11:07:09 -0800662 source_file.data = NULL;
Hristo Bojinovdb314d62010-08-02 10:29:49 -0700663 LoadFileContents(source_filename, &source_file,
664 RETOUCH_DO_MASK);
Doug Zongkerc4351c72010-02-22 14:46:32 -0800665 }
666
667 if (source_file.data != NULL) {
668 int to_use = FindMatchingPatch(source_file.sha1,
669 patch_sha1_str, num_patches);
670 if (to_use >= 0) {
671 source_patch_value = patch_data[to_use];
672 }
673 }
674
675 if (source_patch_value == NULL) {
676 free(source_file.data);
Doug Zongker1c43c972012-02-28 11:07:09 -0800677 source_file.data = NULL;
Doug Zongkerc4351c72010-02-22 14:46:32 -0800678 printf("source file is bad; trying copy\n");
679
Hristo Bojinovdb314d62010-08-02 10:29:49 -0700680 if (LoadFileContents(CACHE_TEMP_SOURCE, &copy_file,
681 RETOUCH_DO_MASK) < 0) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800682 // fail.
683 printf("failed to read copy file\n");
684 return 1;
Doug Zongker512536a2010-02-17 16:11:44 -0800685 }
686
Doug Zongkerc4351c72010-02-22 14:46:32 -0800687 int to_use = FindMatchingPatch(copy_file.sha1,
688 patch_sha1_str, num_patches);
Doug Zongker8cd9e4f2010-08-12 17:38:09 -0700689 if (to_use >= 0) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800690 copy_patch_value = patch_data[to_use];
Doug Zongker512536a2010-02-17 16:11:44 -0800691 }
692
Doug Zongkerc4351c72010-02-22 14:46:32 -0800693 if (copy_patch_value == NULL) {
694 // fail.
695 printf("copy file doesn't match source SHA-1s either\n");
Doug Zongker1c43c972012-02-28 11:07:09 -0800696 free(copy_file.data);
Doug Zongkerc4351c72010-02-22 14:46:32 -0800697 return 1;
Doug Zongker512536a2010-02-17 16:11:44 -0800698 }
Doug Zongker512536a2010-02-17 16:11:44 -0800699 }
700
Doug Zongker1c43c972012-02-28 11:07:09 -0800701 int result = GenerateTarget(&source_file, source_patch_value,
702 &copy_file, copy_patch_value,
703 source_filename, target_filename,
Doug Zongkera3ccba62012-08-20 15:28:02 -0700704 target_sha1, target_size, bonus_data);
Doug Zongker1c43c972012-02-28 11:07:09 -0800705 free(source_file.data);
706 free(copy_file.data);
707
708 return result;
709}
710
711static int GenerateTarget(FileContents* source_file,
712 const Value* source_patch_value,
713 FileContents* copy_file,
714 const Value* copy_patch_value,
715 const char* source_filename,
716 const char* target_filename,
717 const uint8_t target_sha1[SHA_DIGEST_SIZE],
Doug Zongkera3ccba62012-08-20 15:28:02 -0700718 size_t target_size,
719 const Value* bonus_data) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800720 int retry = 1;
721 SHA_CTX ctx;
722 int output;
723 MemorySinkInfo msi;
724 FileContents* source_to_use;
725 char* outname;
Doug Zongker1c43c972012-02-28 11:07:09 -0800726 int made_copy = 0;
Doug Zongkerc4351c72010-02-22 14:46:32 -0800727
728 // assume that target_filename (eg "/system/app/Foo.apk") is located
729 // on the same filesystem as its top-level directory ("/system").
730 // We need something that exists for calling statfs().
731 char target_fs[strlen(target_filename)+1];
732 char* slash = strchr(target_filename+1, '/');
733 if (slash != NULL) {
734 int count = slash - target_filename;
735 strncpy(target_fs, target_filename, count);
736 target_fs[count] = '\0';
Doug Zongker512536a2010-02-17 16:11:44 -0800737 } else {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800738 strcpy(target_fs, target_filename);
Doug Zongker512536a2010-02-17 16:11:44 -0800739 }
740
Doug Zongkerc4351c72010-02-22 14:46:32 -0800741 do {
742 // Is there enough room in the target filesystem to hold the patched
743 // file?
744
Doug Zongkerf291d852010-07-07 13:55:25 -0700745 if (strncmp(target_filename, "MTD:", 4) == 0 ||
746 strncmp(target_filename, "EMMC:", 5) == 0) {
747 // If the target is a partition, we're actually going to
748 // write the output to /tmp and then copy it to the
749 // partition. statfs() always returns 0 blocks free for
750 // /tmp, so instead we'll just assume that /tmp has enough
751 // space to hold the file.
Doug Zongkerc4351c72010-02-22 14:46:32 -0800752
Doug Zongkerf291d852010-07-07 13:55:25 -0700753 // We still write the original source to cache, in case
754 // the partition write is interrupted.
Doug Zongker1c43c972012-02-28 11:07:09 -0800755 if (MakeFreeSpaceOnCache(source_file->size) < 0) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800756 printf("not enough free space on /cache\n");
757 return 1;
758 }
759 if (SaveFileContents(CACHE_TEMP_SOURCE, source_file) < 0) {
760 printf("failed to back up source file\n");
761 return 1;
762 }
763 made_copy = 1;
764 retry = 0;
765 } else {
766 int enough_space = 0;
767 if (retry > 0) {
768 size_t free_space = FreeSpaceForFile(target_fs);
Doug Zongker201cd462010-08-13 09:41:21 -0700769 enough_space =
770 (free_space > (256 << 10)) && // 256k (two-block) minimum
Doug Zongkerc4351c72010-02-22 14:46:32 -0800771 (free_space > (target_size * 3 / 2)); // 50% margin of error
772 printf("target %ld bytes; free space %ld bytes; retry %d; enough %d\n",
773 (long)target_size, (long)free_space, retry, enough_space);
774 }
775
776 if (!enough_space) {
777 retry = 0;
778 }
779
780 if (!enough_space && source_patch_value != NULL) {
781 // Using the original source, but not enough free space. First
782 // copy the source file to cache, then delete it from the original
783 // location.
784
Doug Zongkerf291d852010-07-07 13:55:25 -0700785 if (strncmp(source_filename, "MTD:", 4) == 0 ||
786 strncmp(source_filename, "EMMC:", 5) == 0) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800787 // It's impossible to free space on the target filesystem by
Doug Zongkerf291d852010-07-07 13:55:25 -0700788 // deleting the source if the source is a partition. If
Doug Zongkerc4351c72010-02-22 14:46:32 -0800789 // we're ever in a state where we need to do this, fail.
Doug Zongkerf291d852010-07-07 13:55:25 -0700790 printf("not enough free space for target but source "
791 "is partition\n");
Doug Zongkerc4351c72010-02-22 14:46:32 -0800792 return 1;
793 }
794
Doug Zongker1c43c972012-02-28 11:07:09 -0800795 if (MakeFreeSpaceOnCache(source_file->size) < 0) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800796 printf("not enough free space on /cache\n");
797 return 1;
798 }
799
800 if (SaveFileContents(CACHE_TEMP_SOURCE, source_file) < 0) {
801 printf("failed to back up source file\n");
802 return 1;
803 }
804 made_copy = 1;
805 unlink(source_filename);
806
807 size_t free_space = FreeSpaceForFile(target_fs);
808 printf("(now %ld bytes free for target)\n", (long)free_space);
809 }
810 }
811
812 const Value* patch;
813 if (source_patch_value != NULL) {
Doug Zongker1c43c972012-02-28 11:07:09 -0800814 source_to_use = source_file;
Doug Zongkerc4351c72010-02-22 14:46:32 -0800815 patch = source_patch_value;
816 } else {
Doug Zongker1c43c972012-02-28 11:07:09 -0800817 source_to_use = copy_file;
Doug Zongkerc4351c72010-02-22 14:46:32 -0800818 patch = copy_patch_value;
819 }
820
821 if (patch->type != VAL_BLOB) {
822 printf("patch is not a blob\n");
823 return 1;
824 }
825
826 SinkFn sink = NULL;
827 void* token = NULL;
828 output = -1;
829 outname = NULL;
Doug Zongkerf291d852010-07-07 13:55:25 -0700830 if (strncmp(target_filename, "MTD:", 4) == 0 ||
831 strncmp(target_filename, "EMMC:", 5) == 0) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800832 // We store the decoded output in memory.
833 msi.buffer = malloc(target_size);
834 if (msi.buffer == NULL) {
835 printf("failed to alloc %ld bytes for output\n",
836 (long)target_size);
837 return 1;
838 }
839 msi.pos = 0;
840 msi.size = target_size;
841 sink = MemorySink;
842 token = &msi;
843 } else {
844 // We write the decoded output to "<tgt-file>.patch".
845 outname = (char*)malloc(strlen(target_filename) + 10);
846 strcpy(outname, target_filename);
847 strcat(outname, ".patch");
848
Nick Kralevich956cde82012-06-26 15:01:03 -0700849 output = open(outname, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
Doug Zongkerc4351c72010-02-22 14:46:32 -0800850 if (output < 0) {
851 printf("failed to open output file %s: %s\n",
852 outname, strerror(errno));
853 return 1;
854 }
855 sink = FileSink;
856 token = &output;
857 }
858
859 char* header = patch->data;
860 ssize_t header_bytes_read = patch->size;
861
862 SHA_init(&ctx);
863
864 int result;
865
866 if (header_bytes_read >= 8 &&
867 memcmp(header, "BSDIFF40", 8) == 0) {
868 result = ApplyBSDiffPatch(source_to_use->data, source_to_use->size,
869 patch, 0, sink, token, &ctx);
870 } else if (header_bytes_read >= 8 &&
871 memcmp(header, "IMGDIFF2", 8) == 0) {
872 result = ApplyImagePatch(source_to_use->data, source_to_use->size,
Doug Zongkera3ccba62012-08-20 15:28:02 -0700873 patch, sink, token, &ctx, bonus_data);
Doug Zongkerc4351c72010-02-22 14:46:32 -0800874 } else {
875 printf("Unknown patch file format\n");
876 return 1;
877 }
878
879 if (output >= 0) {
880 fsync(output);
881 close(output);
882 }
883
884 if (result != 0) {
885 if (retry == 0) {
886 printf("applying patch failed\n");
887 return result != 0;
888 } else {
889 printf("applying patch failed; retrying\n");
890 }
891 if (outname != NULL) {
892 unlink(outname);
893 }
894 } else {
895 // succeeded; no need to retry
896 break;
897 }
898 } while (retry-- > 0);
899
900 const uint8_t* current_target_sha1 = SHA_final(&ctx);
901 if (memcmp(current_target_sha1, target_sha1, SHA_DIGEST_SIZE) != 0) {
902 printf("patch did not produce expected sha1\n");
Doug Zongker512536a2010-02-17 16:11:44 -0800903 return 1;
Doug Zongkerc4351c72010-02-22 14:46:32 -0800904 }
905
906 if (output < 0) {
Doug Zongkerf291d852010-07-07 13:55:25 -0700907 // Copy the temp file to the partition.
908 if (WriteToPartition(msi.buffer, msi.pos, target_filename) != 0) {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800909 printf("write of patched data to %s failed\n", target_filename);
910 return 1;
911 }
912 free(msi.buffer);
Doug Zongker512536a2010-02-17 16:11:44 -0800913 } else {
Doug Zongkerc4351c72010-02-22 14:46:32 -0800914 // Give the .patch file the same owner, group, and mode of the
915 // original source file.
916 if (chmod(outname, source_to_use->st.st_mode) != 0) {
917 printf("chmod of \"%s\" failed: %s\n", outname, strerror(errno));
918 return 1;
919 }
920 if (chown(outname, source_to_use->st.st_uid,
921 source_to_use->st.st_gid) != 0) {
922 printf("chown of \"%s\" failed: %s\n", outname, strerror(errno));
923 return 1;
924 }
Doug Zongker512536a2010-02-17 16:11:44 -0800925
Doug Zongkerc4351c72010-02-22 14:46:32 -0800926 // Finally, rename the .patch file to replace the target file.
927 if (rename(outname, target_filename) != 0) {
928 printf("rename of .patch to \"%s\" failed: %s\n",
929 target_filename, strerror(errno));
930 return 1;
931 }
Doug Zongker512536a2010-02-17 16:11:44 -0800932 }
933
Doug Zongkerc4351c72010-02-22 14:46:32 -0800934 // If this run of applypatch created the copy, and we're here, we
935 // can delete it.
936 if (made_copy) unlink(CACHE_TEMP_SOURCE);
Doug Zongker512536a2010-02-17 16:11:44 -0800937
Doug Zongkerc4351c72010-02-22 14:46:32 -0800938 // Success!
939 return 0;
Doug Zongker512536a2010-02-17 16:11:44 -0800940}