Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 1 | // Copyright (c) 2010 The Chromium OS Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef CHROMEOS_PLATFORM_UPDATE_ENGINE_DELTA_PERFORMER_H__ |
| 6 | #define CHROMEOS_PLATFORM_UPDATE_ENGINE_DELTA_PERFORMER_H__ |
| 7 | |
| 8 | #include <inttypes.h> |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame^] | 9 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 10 | #include <vector> |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame^] | 11 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 12 | #include <google/protobuf/repeated_field.h> |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame^] | 13 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 14 | #include "update_engine/file_writer.h" |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame^] | 15 | #include "update_engine/omaha_hash_calculator.h" |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 16 | #include "update_engine/update_metadata.pb.h" |
| 17 | |
| 18 | namespace chromeos_update_engine { |
| 19 | |
| 20 | // This class performs the actions in a delta update synchronously. The delta |
| 21 | // update itself should be passed in in chunks as it is received. |
| 22 | |
| 23 | class DeltaPerformer : public FileWriter { |
| 24 | public: |
| 25 | DeltaPerformer() |
| 26 | : fd_(-1), |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 27 | kernel_fd_(-1), |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 28 | manifest_valid_(false), |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 29 | next_operation_num_(0), |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 30 | buffer_offset_(0), |
| 31 | block_size_(0) {} |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame^] | 32 | |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 33 | // Opens the kernel. Should be called before or after Open(), but before |
| 34 | // Write(). The kernel file will be close()d when Close() is called. |
| 35 | bool OpenKernel(const char* kernel_path); |
| 36 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 37 | // flags and mode ignored. Once Close()d, a DeltaPerformer can't be |
| 38 | // Open()ed again. |
| 39 | int Open(const char* path, int flags, mode_t mode); |
| 40 | |
| 41 | // Wrapper around write. Returns bytes written on success or |
| 42 | // -errno on error. |
Andrew de los Reyes | 0cca421 | 2010-04-29 14:00:58 -0700 | [diff] [blame] | 43 | ssize_t Write(const void* bytes, size_t count); |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 44 | |
| 45 | // Wrapper around close. Returns 0 on success or -errno on error. |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 46 | // Closes both 'path' given to Open() and the kernel path. |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 47 | int Close(); |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame^] | 48 | |
| 49 | // Verifies the downloaded payload against the signed hash included in the |
| 50 | // payload and returns true on success, false on failure. This method should |
| 51 | // be called after closing the stream. Note this method returns true if the |
| 52 | // public key is unavailable; it returns false if the public key is available |
| 53 | // but the delta payload doesn't include a signature. If |public_key_path| is |
| 54 | // an empty string, uses the default public key path. |
| 55 | bool VerifyPayload(const std::string& public_key_path); |
| 56 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 57 | // Converts an ordered collection of Extent objects which contain data of |
| 58 | // length full_length to a comma-separated string. For each Extent, the |
| 59 | // string will have the start offset and then the length in bytes. |
| 60 | // The length value of the last extent in the string may be short, since |
| 61 | // the full length of all extents in the string is capped to full_length. |
| 62 | // Also, an extent starting at kSparseHole, appears as -1 in the string. |
| 63 | // For example, if the Extents are {1, 1}, {4, 2}, {kSparseHole, 1}, |
| 64 | // {0, 1}, block_size is 4096, and full_length is 5 * block_size - 13, |
| 65 | // the resulting string will be: "4096:4096,16384:8192,-1:4096,0:4083" |
| 66 | static bool ExtentsToBsdiffPositionsString( |
| 67 | const google::protobuf::RepeatedPtrField<Extent>& extents, |
| 68 | uint64_t block_size, |
| 69 | uint64_t full_length, |
| 70 | std::string* positions_string); |
| 71 | |
| 72 | private: |
| 73 | // Returns true if enough of the delta file has been passed via Write() |
| 74 | // to be able to perform a given install operation. |
| 75 | bool CanPerformInstallOperation( |
| 76 | const DeltaArchiveManifest_InstallOperation& operation); |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame^] | 77 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 78 | // Returns true on success. |
| 79 | bool PerformInstallOperation( |
| 80 | const DeltaArchiveManifest_InstallOperation& operation); |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame^] | 81 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 82 | // These perform a specific type of operation and return true on success. |
| 83 | bool PerformReplaceOperation( |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 84 | const DeltaArchiveManifest_InstallOperation& operation, |
| 85 | bool is_kernel_partition); |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 86 | bool PerformMoveOperation( |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 87 | const DeltaArchiveManifest_InstallOperation& operation, |
| 88 | bool is_kernel_partition); |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 89 | bool PerformBsdiffOperation( |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 90 | const DeltaArchiveManifest_InstallOperation& operation, |
| 91 | bool is_kernel_partition); |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 92 | |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame^] | 93 | // Returns true if the payload signature message has been extracted from |
| 94 | // |operation|, false otherwise. |
| 95 | bool ExtractSignatureMessage( |
| 96 | const DeltaArchiveManifest_InstallOperation& operation); |
| 97 | |
| 98 | // Discard |count| bytes from the beginning of buffer_. If |do_hash| is true, |
| 99 | // updates the hash calculator with these bytes before discarding them. |
| 100 | void DiscardBufferHeadBytes(size_t count, bool do_hash); |
| 101 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 102 | // File descriptor of open device. |
| 103 | int fd_; |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame^] | 104 | |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 105 | // File descriptor of the kernel device |
| 106 | int kernel_fd_; |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame^] | 107 | |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 108 | std::string path_; // Path that fd_ refers to. |
| 109 | std::string kernel_path_; // Path that kernel_fd_ refers to. |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame^] | 110 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 111 | DeltaArchiveManifest manifest_; |
| 112 | bool manifest_valid_; |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame^] | 113 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 114 | // Index of the next operation to perform in the manifest. |
Andrew de los Reyes | f4c7ef1 | 2010-04-30 10:37:00 -0700 | [diff] [blame] | 115 | int next_operation_num_; |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 116 | |
| 117 | // buffer_ is a window of the data that's been downloaded. At first, |
| 118 | // it contains the beginning of the download, but after the protobuf |
| 119 | // has been downloaded and parsed, it contains a sliding window of |
| 120 | // data blobs. |
| 121 | std::vector<char> buffer_; |
| 122 | // Offset of buffer_ in the binary blobs section of the update. |
| 123 | uint64_t buffer_offset_; |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame^] | 124 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 125 | // The block size (parsed from the manifest). |
| 126 | uint32_t block_size_; |
Darin Petkov | d7061ab | 2010-10-06 14:37:09 -0700 | [diff] [blame^] | 127 | |
| 128 | // Calculate the payload hash to verify against the signed hash. |
| 129 | OmahaHashCalculator hash_calculator_; |
| 130 | |
| 131 | // Signatures message blob extracted directly from the payload. |
| 132 | std::vector<char> signatures_message_data_; |
| 133 | |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 134 | DISALLOW_COPY_AND_ASSIGN(DeltaPerformer); |
| 135 | }; |
| 136 | |
| 137 | } // namespace chromeos_update_engine |
| 138 | |
| 139 | #endif // CHROMEOS_PLATFORM_UPDATE_ENGINE_DELTA_PERFORMER_H__ |