xref: /aosp_15_r20/external/bsdiff/patch_reader.cc (revision a3a45f308bd90ef1a6e6a5e8fb92fe449b895909)
1*a3a45f30SXin Li // Copyright 2017 The Chromium OS Authors. All rights reserved.
2*a3a45f30SXin Li // Use of this source code is governed by a BSD-style license that can be
3*a3a45f30SXin Li // found in the LICENSE file.
4*a3a45f30SXin Li 
5*a3a45f30SXin Li #include "bsdiff/patch_reader.h"
6*a3a45f30SXin Li 
7*a3a45f30SXin Li #include <string.h>
8*a3a45f30SXin Li 
9*a3a45f30SXin Li #include <limits>
10*a3a45f30SXin Li #include <vector>
11*a3a45f30SXin Li 
12*a3a45f30SXin Li #include "bsdiff/brotli_decompressor.h"
13*a3a45f30SXin Li #include "bsdiff/bspatch.h"
14*a3a45f30SXin Li #include "bsdiff/bz2_decompressor.h"
15*a3a45f30SXin Li #include "bsdiff/constants.h"
16*a3a45f30SXin Li #include "bsdiff/logging.h"
17*a3a45f30SXin Li #include "bsdiff/utils.h"
18*a3a45f30SXin Li 
19*a3a45f30SXin Li namespace bsdiff {
20*a3a45f30SXin Li 
Init(const uint8_t * patch_data,size_t patch_size)21*a3a45f30SXin Li bool BsdiffPatchReader::Init(const uint8_t* patch_data, size_t patch_size) {
22*a3a45f30SXin Li   //   File format:
23*a3a45f30SXin Li   //   0       8    magic header
24*a3a45f30SXin Li   //   8       8    X
25*a3a45f30SXin Li   //   16      8    Y
26*a3a45f30SXin Li   //   24      8    new_file_size
27*a3a45f30SXin Li   //   32      X    compressed control block
28*a3a45f30SXin Li   //   32+X    Y    compressed diff block
29*a3a45f30SXin Li   //   32+X+Y  ???  compressed extra block
30*a3a45f30SXin Li   // with control block a set of triples (x,y,z) meaning "add x bytes
31*a3a45f30SXin Li   // from oldfile to x bytes from the diff block; copy y bytes from the
32*a3a45f30SXin Li   // extra block; seek forwards in oldfile by z bytes".
33*a3a45f30SXin Li 
34*a3a45f30SXin Li   if (patch_size < 32) {
35*a3a45f30SXin Li     LOG(ERROR) << "Too small to be a bspatch. " << patch_size;
36*a3a45f30SXin Li     return false;
37*a3a45f30SXin Li   }
38*a3a45f30SXin Li   // Check for appropriate magic.
39*a3a45f30SXin Li   std::vector<CompressorType> compression_type;
40*a3a45f30SXin Li   if (memcmp(patch_data, kLegacyMagicHeader, 8) == 0) {
41*a3a45f30SXin Li     // The magic header is "BSDIFF40" for legacy format.
42*a3a45f30SXin Li     compression_type = {CompressorType::kBZ2, CompressorType::kBZ2,
43*a3a45f30SXin Li                         CompressorType::kBZ2};
44*a3a45f30SXin Li   } else if (memcmp(patch_data, kBSDF2MagicHeader, 5) == 0) {
45*a3a45f30SXin Li     // The magic header for BSDF2 format:
46*a3a45f30SXin Li     // 0 5 BSDF2
47*a3a45f30SXin Li     // 5 1 compressed type for control stream
48*a3a45f30SXin Li     // 6 1 compressed type for diff stream
49*a3a45f30SXin Li     // 7 1 compressed type for extra stream
50*a3a45f30SXin Li     for (size_t i = 5; i < 8; i++) {
51*a3a45f30SXin Li       uint8_t type = patch_data[i];
52*a3a45f30SXin Li       switch (type) {
53*a3a45f30SXin Li         case static_cast<uint8_t>(CompressorType::kBZ2):
54*a3a45f30SXin Li           compression_type.push_back(CompressorType::kBZ2);
55*a3a45f30SXin Li           break;
56*a3a45f30SXin Li         case static_cast<uint8_t>(CompressorType::kBrotli):
57*a3a45f30SXin Li           compression_type.push_back(CompressorType::kBrotli);
58*a3a45f30SXin Li           break;
59*a3a45f30SXin Li         default:
60*a3a45f30SXin Li           LOG(ERROR) << "Unsupported compression type: "
61*a3a45f30SXin Li                      << static_cast<int>(type);
62*a3a45f30SXin Li           return false;
63*a3a45f30SXin Li       }
64*a3a45f30SXin Li     }
65*a3a45f30SXin Li   } else {
66*a3a45f30SXin Li     LOG(ERROR) << "Not a bsdiff patch.";
67*a3a45f30SXin Li     return false;
68*a3a45f30SXin Li   }
69*a3a45f30SXin Li 
70*a3a45f30SXin Li   // Read lengths from header.
71*a3a45f30SXin Li   int64_t ctrl_len = ParseInt64(patch_data + 8);
72*a3a45f30SXin Li   int64_t diff_len = ParseInt64(patch_data + 16);
73*a3a45f30SXin Li   int64_t signed_newsize = ParseInt64(patch_data + 24);
74*a3a45f30SXin Li   // We already checked that the patch_size is at least 32 bytes.
75*a3a45f30SXin Li   if ((ctrl_len < 0) || (diff_len < 0) || (signed_newsize < 0) ||
76*a3a45f30SXin Li       (static_cast<int64_t>(patch_size) - 32 < ctrl_len) ||
77*a3a45f30SXin Li       (static_cast<int64_t>(patch_size) - 32 - ctrl_len < diff_len)) {
78*a3a45f30SXin Li     LOG(ERROR) << "Corrupt patch.  ctrl_len: " << ctrl_len
79*a3a45f30SXin Li                << ", data_len: " << diff_len
80*a3a45f30SXin Li                << ", new_file_size: " << signed_newsize
81*a3a45f30SXin Li                << ", patch_size: " << patch_size;
82*a3a45f30SXin Li     return false;
83*a3a45f30SXin Li   }
84*a3a45f30SXin Li   new_file_size_ = signed_newsize;
85*a3a45f30SXin Li 
86*a3a45f30SXin Li   ctrl_stream_ = CreateDecompressor(compression_type[0]);
87*a3a45f30SXin Li   diff_stream_ = CreateDecompressor(compression_type[1]);
88*a3a45f30SXin Li   extra_stream_ = CreateDecompressor(compression_type[2]);
89*a3a45f30SXin Li   if (!(ctrl_stream_ && diff_stream_ && extra_stream_)) {
90*a3a45f30SXin Li     LOG(ERROR) << "uninitialized decompressor stream";
91*a3a45f30SXin Li     return false;
92*a3a45f30SXin Li   }
93*a3a45f30SXin Li 
94*a3a45f30SXin Li   size_t offset = 32;
95*a3a45f30SXin Li   if (!ctrl_stream_->SetInputData(const_cast<uint8_t*>(patch_data) + offset,
96*a3a45f30SXin Li                                   ctrl_len)) {
97*a3a45f30SXin Li     LOG(ERROR) << "Failed to init ctrl stream, ctrl_len: " << ctrl_len;
98*a3a45f30SXin Li     return false;
99*a3a45f30SXin Li   }
100*a3a45f30SXin Li 
101*a3a45f30SXin Li   offset += ctrl_len;
102*a3a45f30SXin Li   if (!diff_stream_->SetInputData(const_cast<uint8_t*>(patch_data) + offset,
103*a3a45f30SXin Li                                   diff_len)) {
104*a3a45f30SXin Li     LOG(ERROR) << "Failed to init ctrl stream, diff_len: " << diff_len;
105*a3a45f30SXin Li     return false;
106*a3a45f30SXin Li   }
107*a3a45f30SXin Li 
108*a3a45f30SXin Li   offset += diff_len;
109*a3a45f30SXin Li   if (!extra_stream_->SetInputData(const_cast<uint8_t*>(patch_data) + offset,
110*a3a45f30SXin Li                                    patch_size - offset)) {
111*a3a45f30SXin Li     LOG(ERROR) << "Failed to init extra stream, extra_offset: " << offset
112*a3a45f30SXin Li                << ", patch_size: " << patch_size;
113*a3a45f30SXin Li     return false;
114*a3a45f30SXin Li   }
115*a3a45f30SXin Li   return true;
116*a3a45f30SXin Li }
117*a3a45f30SXin Li 
ParseControlEntry(ControlEntry * control_entry)118*a3a45f30SXin Li bool BsdiffPatchReader::ParseControlEntry(ControlEntry* control_entry) {
119*a3a45f30SXin Li   if (!control_entry)
120*a3a45f30SXin Li     return false;
121*a3a45f30SXin Li 
122*a3a45f30SXin Li   uint8_t buf[8];
123*a3a45f30SXin Li   if (!ctrl_stream_->Read(buf, 8))
124*a3a45f30SXin Li     return false;
125*a3a45f30SXin Li   int64_t diff_size = ParseInt64(buf);
126*a3a45f30SXin Li 
127*a3a45f30SXin Li   if (!ctrl_stream_->Read(buf, 8))
128*a3a45f30SXin Li     return false;
129*a3a45f30SXin Li   int64_t extra_size = ParseInt64(buf);
130*a3a45f30SXin Li 
131*a3a45f30SXin Li   // Sanity check.
132*a3a45f30SXin Li   if (diff_size < 0 || extra_size < 0) {
133*a3a45f30SXin Li     LOG(ERROR) << "Corrupt patch; diff_size: " << diff_size
134*a3a45f30SXin Li                << ", extra_size: " << extra_size;
135*a3a45f30SXin Li     return false;
136*a3a45f30SXin Li   }
137*a3a45f30SXin Li 
138*a3a45f30SXin Li   control_entry->diff_size = diff_size;
139*a3a45f30SXin Li   control_entry->extra_size = extra_size;
140*a3a45f30SXin Li 
141*a3a45f30SXin Li   if (!ctrl_stream_->Read(buf, 8))
142*a3a45f30SXin Li     return false;
143*a3a45f30SXin Li   control_entry->offset_increment = ParseInt64(buf);
144*a3a45f30SXin Li 
145*a3a45f30SXin Li   return true;
146*a3a45f30SXin Li }
147*a3a45f30SXin Li 
ReadDiffStream(uint8_t * buf,size_t size)148*a3a45f30SXin Li bool BsdiffPatchReader::ReadDiffStream(uint8_t* buf, size_t size) {
149*a3a45f30SXin Li   return diff_stream_->Read(buf, size);
150*a3a45f30SXin Li }
151*a3a45f30SXin Li 
ReadExtraStream(uint8_t * buf,size_t size)152*a3a45f30SXin Li bool BsdiffPatchReader::ReadExtraStream(uint8_t* buf, size_t size) {
153*a3a45f30SXin Li   return extra_stream_->Read(buf, size);
154*a3a45f30SXin Li }
155*a3a45f30SXin Li 
Finish()156*a3a45f30SXin Li bool BsdiffPatchReader::Finish() {
157*a3a45f30SXin Li   if (!ctrl_stream_->Close()) {
158*a3a45f30SXin Li     LOG(ERROR) << "Failed to close the control stream";
159*a3a45f30SXin Li     return false;
160*a3a45f30SXin Li   }
161*a3a45f30SXin Li 
162*a3a45f30SXin Li   if (!diff_stream_->Close()) {
163*a3a45f30SXin Li     LOG(ERROR) << "Failed to close the diff stream";
164*a3a45f30SXin Li     return false;
165*a3a45f30SXin Li   }
166*a3a45f30SXin Li 
167*a3a45f30SXin Li   if (!extra_stream_->Close()) {
168*a3a45f30SXin Li     LOG(ERROR) << "Failed to close the extra stream";
169*a3a45f30SXin Li     return false;
170*a3a45f30SXin Li   }
171*a3a45f30SXin Li   return true;
172*a3a45f30SXin Li }
173*a3a45f30SXin Li 
174*a3a45f30SXin Li }  // namespace bsdiff
175