1 // 2 // Copyright (C) 2015 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 #ifndef UPDATE_ENGINE_PAYLOAD_GENERATOR_PAYLOAD_FILE_H_ 18 #define UPDATE_ENGINE_PAYLOAD_GENERATOR_PAYLOAD_FILE_H_ 19 20 #include <string> 21 #include <vector> 22 23 #include <brillo/secure_blob.h> 24 #include <gtest/gtest_prod.h> // for FRIEND_TEST 25 26 #include "update_engine/payload_generator/annotated_operation.h" 27 #include "update_engine/payload_generator/payload_generation_config.h" 28 #include "update_engine/update_metadata.pb.h" 29 30 namespace chromeos_update_engine { 31 32 // Class to handle the creation of a payload file. This class is the only one 33 // dealing with writing the payload and its format, but has no logic about what 34 // should be on it. 35 class PayloadFile { 36 public: 37 // Initialize the payload file with the payload generation config. It computes 38 // required hashes of the requested partitions. 39 bool Init(const PayloadGenerationConfig& config); 40 41 // Add a partition to the payload manifest. Including partition name, list of 42 // operations and partition info. The operations in |aops| 43 // reference a blob stored in the file provided to WritePayload(). 44 bool AddPartition(const PartitionConfig& old_conf, 45 const PartitionConfig& new_conf, 46 std::vector<AnnotatedOperation> aops, 47 std::vector<CowMergeOperation> merge_sequence, 48 size_t cow_size); 49 50 // Write the payload to the |payload_file| file. The operations reference 51 // blobs in the |data_blobs_path| file and the blobs will be reordered in the 52 // payload file to match the order of the operations. The size of the metadata 53 // section of the payload is stored in |metadata_size_out|. 54 bool WritePayload(const std::string& payload_file, 55 const std::string& data_blobs_path, 56 const std::string& private_key_path, 57 uint64_t* metadata_size_out); 58 59 private: 60 FRIEND_TEST(PayloadFileTest, ReorderBlobsTest); 61 62 // Computes a SHA256 hash of the given buf and sets the hash value in the 63 // operation so that update_engine could verify. This hash should be set 64 // for all operations that have a non-zero data blob. One exception is the 65 // fake operation for signature blob because the contents of the signature 66 // blob will not be available at payload creation time. So, update_engine will 67 // gracefully ignore the fake signature operation. 68 static bool AddOperationHash(InstallOperation* op, const brillo::Blob& buf); 69 70 // Install operations in the manifest may reference data blobs, which 71 // are in data_blobs_path. This function creates a new data blobs file 72 // with the data blobs in the same order as the referencing install 73 // operations in the manifest. E.g. if manifest[0] has a data blob 74 // "X" at offset 1, manifest[1] has a data blob "Y" at offset 0, 75 // and data_blobs_path's file contains "YX", new_data_blobs_path 76 // will set to be a file that contains "XY". 77 bool ReorderDataBlobs(const std::string& data_blobs_path, 78 const std::string& new_data_blobs_path); 79 80 // Print in stderr the Payload usage report. 81 void ReportPayloadUsage(uint64_t metadata_size) const; 82 83 // The major_version of the requested payload. 84 uint64_t major_version_; 85 86 DeltaArchiveManifest manifest_; 87 88 // Struct has necessary information to write PartitionUpdate in protobuf. 89 struct Partition { 90 // The name of the partition. 91 std::string name; 92 93 // The operations to be performed to this partition. 94 std::vector<AnnotatedOperation> aops; 95 std::vector<CowMergeOperation> cow_merge_sequence; 96 97 PartitionInfo old_info; 98 PartitionInfo new_info; 99 100 PostInstallConfig postinstall; 101 VerityConfig verity; 102 // Per partition timestamp. 103 std::string version; 104 size_t cow_size; 105 }; 106 107 std::vector<Partition> part_vec_; 108 }; 109 110 } // namespace chromeos_update_engine 111 112 #endif // UPDATE_ENGINE_PAYLOAD_GENERATOR_PAYLOAD_FILE_H_ 113