1 // 2 // Copyright (C) 2011 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_CONSUMER_INSTALL_PLAN_H_ 18 #define UPDATE_ENGINE_PAYLOAD_CONSUMER_INSTALL_PLAN_H_ 19 20 #include <string> 21 #include <vector> 22 23 #include <base/macros.h> 24 #include <brillo/secure_blob.h> 25 26 #include "update_engine/common/action.h" 27 #include "update_engine/common/boot_control_interface.h" 28 29 // InstallPlan is a simple struct that contains relevant info for many 30 // parts of the update system about the install that should happen. 31 namespace chromeos_update_engine { 32 33 enum class InstallPayloadType { 34 kUnknown, 35 kFull, 36 kDelta, 37 }; 38 39 std::string InstallPayloadTypeToString(InstallPayloadType type); 40 41 struct InstallPlan { 42 InstallPlan() = default; 43 44 bool operator==(const InstallPlan& that) const; 45 bool operator!=(const InstallPlan& that) const; 46 47 void Dump() const; 48 49 // Load the |source_path| and |target_path| of all |partitions| based on the 50 // |source_slot| and |target_slot| if available. Returns whether it succeeded 51 // to load all the partitions for the valid slots. 52 bool LoadPartitionsFromSlots(BootControlInterface* boot_control); 53 54 bool is_resume{false}; 55 InstallPayloadType payload_type{InstallPayloadType::kUnknown}; 56 std::string download_url; // url to download from 57 std::string version; // version we are installing. 58 59 uint64_t payload_size{0}; // size of the payload 60 std::string payload_hash; // SHA256 hash of the payload 61 uint64_t metadata_size{0}; // size of the metadata 62 std::string metadata_signature; // signature of the metadata 63 64 // The partition slots used for the update. 65 BootControlInterface::Slot source_slot{BootControlInterface::kInvalidSlot}; 66 BootControlInterface::Slot target_slot{BootControlInterface::kInvalidSlot}; 67 68 // The vector below is used for partition verification. The flow is: 69 // 70 // 1. DownloadAction fills in the expected source and target partition sizes 71 // and hashes based on the manifest. 72 // 73 // 2. FilesystemVerifierAction computes and verifies the partition sizes and 74 // hashes against the expected values. 75 struct Partition { 76 bool operator==(const Partition& that) const; 77 78 // The name of the partition. 79 std::string name; 80 81 std::string source_path; 82 uint64_t source_size{0}; 83 brillo::Blob source_hash; 84 85 std::string target_path; 86 uint64_t target_size{0}; 87 brillo::Blob target_hash; 88 89 // Whether we should run the postinstall script from this partition and the 90 // postinstall parameters. 91 bool run_postinstall{false}; 92 std::string postinstall_path; 93 std::string filesystem_type; 94 bool postinstall_optional{false}; 95 }; 96 std::vector<Partition> partitions; 97 98 // True if payload hash checks are mandatory based on the system state and 99 // the Omaha response. 100 bool hash_checks_mandatory{false}; 101 102 // True if Powerwash is required on reboot after applying the payload. 103 // False otherwise. 104 bool powerwash_required{false}; 105 106 // If not blank, a base-64 encoded representation of the PEM-encoded 107 // public key in the response. 108 std::string public_key_rsa; 109 }; 110 111 class InstallPlanAction; 112 113 template<> 114 class ActionTraits<InstallPlanAction> { 115 public: 116 // Takes the install plan as input 117 typedef InstallPlan InputObjectType; 118 // Passes the install plan as output 119 typedef InstallPlan OutputObjectType; 120 }; 121 122 // Basic action that only receives and sends Install Plans. 123 // Can be used to construct an Install Plan to send to any other Action that 124 // accept an InstallPlan. 125 class InstallPlanAction : public Action<InstallPlanAction> { 126 public: InstallPlanAction()127 InstallPlanAction() {} InstallPlanAction(const InstallPlan & install_plan)128 explicit InstallPlanAction(const InstallPlan& install_plan): 129 install_plan_(install_plan) {} 130 PerformAction()131 void PerformAction() override { 132 if (HasOutputPipe()) { 133 SetOutputObject(install_plan_); 134 } 135 processor_->ActionComplete(this, ErrorCode::kSuccess); 136 } 137 install_plan()138 InstallPlan* install_plan() { return &install_plan_; } 139 StaticType()140 static std::string StaticType() { return "InstallPlanAction"; } Type()141 std::string Type() const override { return StaticType(); } 142 143 typedef ActionTraits<InstallPlanAction>::InputObjectType InputObjectType; 144 typedef ActionTraits<InstallPlanAction>::OutputObjectType OutputObjectType; 145 146 private: 147 InstallPlan install_plan_; 148 149 DISALLOW_COPY_AND_ASSIGN(InstallPlanAction); 150 }; 151 152 } // namespace chromeos_update_engine 153 154 #endif // UPDATE_ENGINE_PAYLOAD_CONSUMER_INSTALL_PLAN_H_ 155