Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 1 | // Copyright 2018 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 | |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 5 | #include <memory> |
| 6 | #include <utility> |
| 7 | |
Qijiang Fan | 713061e | 2021-03-08 15:45:12 +0900 | [diff] [blame^] | 8 | #include <base/check.h> |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 9 | #include <base/json/json_reader.h> |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 10 | #include <base/strings/string_number_conversions.h> |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 11 | #include <base/values.h> |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 12 | |
Xiaochu Liu | e61e1d6 | 2018-11-12 13:20:09 -0800 | [diff] [blame] | 13 | #include "imageloader/manifest.h" |
| 14 | |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 15 | namespace imageloader { |
| 16 | |
| 17 | namespace { |
| 18 | // The current version of the manifest file. |
| 19 | constexpr int kCurrentManifestVersion = 1; |
| 20 | // The name of the version field in the manifest. |
| 21 | constexpr char kManifestVersionField[] = "manifest-version"; |
| 22 | // The name of the component version field in the manifest. |
| 23 | constexpr char kVersionField[] = "version"; |
| 24 | // The name of the field containing the image hash. |
| 25 | constexpr char kImageHashField[] = "image-sha256-hash"; |
| 26 | // The name of the bool field indicating whether component is removable. |
| 27 | constexpr char kIsRemovableField[] = "is-removable"; |
| 28 | // The name of the metadata field. |
| 29 | constexpr char kMetadataField[] = "metadata"; |
| 30 | // The name of the field containing the table hash. |
| 31 | constexpr char kTableHashField[] = "table-sha256-hash"; |
Colin Howes | dc15ba2 | 2018-12-12 11:02:42 -0800 | [diff] [blame] | 32 | // Optional manifest fields. |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 33 | constexpr char kFSType[] = "fs-type"; |
Colin Howes | dc15ba2 | 2018-12-12 11:02:42 -0800 | [diff] [blame] | 34 | constexpr char kId[] = "id"; |
Amin Hassani | 0badef1 | 2019-03-18 17:08:02 -0700 | [diff] [blame] | 35 | constexpr char kPackage[] = "package"; |
Colin Howes | dc15ba2 | 2018-12-12 11:02:42 -0800 | [diff] [blame] | 36 | constexpr char kName[] = "name"; |
| 37 | constexpr char kImageType[] = "image-type"; |
| 38 | constexpr char kPreallocatedSize[] = "pre-allocated-size"; |
| 39 | constexpr char kSize[] = "size"; |
Jae Hoon Kim | 81d2b6d | 2020-01-06 16:09:32 -0800 | [diff] [blame] | 40 | constexpr char kPreloadAllowed[] = "preload-allowed"; |
Jae Hoon Kim | 99ee273 | 2020-06-25 15:59:35 -0700 | [diff] [blame] | 41 | constexpr char kMountFileRequired[] = "mount-file-required"; |
Amin Hassani | 192c59a | 2020-04-13 15:11:04 -0700 | [diff] [blame] | 42 | constexpr char kUsedBy[] = "used-by"; |
Amin Hassani | b7c20d6 | 2020-04-23 23:14:53 -0700 | [diff] [blame] | 43 | constexpr char kDescription[] = "description"; |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 44 | |
| 45 | bool GetSHA256FromString(const std::string& hash_str, |
| 46 | std::vector<uint8_t>* bytes) { |
| 47 | if (!base::HexStringToBytes(hash_str, bytes)) |
| 48 | return false; |
| 49 | return bytes->size() == 32; |
| 50 | } |
| 51 | |
| 52 | // Ensure the metadata entry is a dictionary mapping strings to strings and |
| 53 | // parse it into |out_metadata| and return true if so. |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 54 | bool ParseMetadata(const base::Value& metadata_dict, |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 55 | std::map<std::string, std::string>* out_metadata) { |
| 56 | DCHECK(out_metadata); |
| 57 | |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 58 | if (!metadata_dict.is_dict()) { |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 59 | return false; |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 60 | } |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 61 | |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 62 | for (const auto& item : metadata_dict.DictItems()) { |
| 63 | if (!item.second.is_string()) { |
| 64 | LOG(ERROR) << "Key \"" << item.first << "\" did not map to string value"; |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 65 | return false; |
| 66 | } |
| 67 | |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 68 | (*out_metadata)[item.first] = item.second.GetString(); |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 69 | } |
| 70 | |
| 71 | return true; |
| 72 | } |
| 73 | |
| 74 | } // namespace |
| 75 | |
Ben Chan | 791bee2 | 2018-09-27 12:54:21 -0700 | [diff] [blame] | 76 | Manifest::Manifest() |
Xiaochu Liu | d9d853a | 2019-01-23 12:54:18 -0800 | [diff] [blame] | 77 | : manifest_version_(0), |
| 78 | fs_type_(FileSystem::kExt4), |
Jae Hoon Kim | 9c012ac | 2020-02-03 17:37:49 -0800 | [diff] [blame] | 79 | preallocated_size_(0), |
| 80 | size_(0), |
Xiaochu Liu | d9d853a | 2019-01-23 12:54:18 -0800 | [diff] [blame] | 81 | is_removable_(false) {} |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 82 | |
| 83 | bool Manifest::ParseManifest(const std::string& manifest_raw) { |
| 84 | // Now deserialize the manifest json and read out the rest of the component. |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 85 | auto manifest_value = base::JSONReader::ReadAndReturnValueWithError( |
| 86 | manifest_raw, base::JSON_PARSE_RFC); |
| 87 | if (!manifest_value.value) { |
hscham | ab8d1db | 2020-12-02 14:45:20 +0900 | [diff] [blame] | 88 | LOG(ERROR) << "Could not parse the manifest file as JSON. Error: " |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 89 | << manifest_value.error_message; |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 90 | return false; |
| 91 | } |
| 92 | |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 93 | if (!manifest_value.value->is_dict()) { |
| 94 | LOG(ERROR) << "Manifest file is not dictionary."; |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 95 | return false; |
| 96 | } |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 97 | base::Value manifest_dict = std::move(*manifest_value.value); |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 98 | |
| 99 | // This will have to be changed if the manifest version is bumped. |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 100 | base::Optional<int> manifest_version = |
| 101 | manifest_dict.FindIntKey(kManifestVersionField); |
| 102 | if (!manifest_version.has_value()) { |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 103 | LOG(ERROR) << "Could not parse manifest version field from manifest."; |
| 104 | return false; |
| 105 | } |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 106 | if (manifest_version != kCurrentManifestVersion) { |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 107 | LOG(ERROR) << "Unsupported version of the manifest."; |
| 108 | return false; |
| 109 | } |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 110 | manifest_version_ = *manifest_version; |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 111 | |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 112 | const std::string* image_hash_str = |
| 113 | manifest_dict.FindStringKey(kImageHashField); |
| 114 | if (!image_hash_str) { |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 115 | LOG(ERROR) << "Could not parse image hash from manifest."; |
| 116 | return false; |
| 117 | } |
| 118 | |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 119 | if (!GetSHA256FromString(*image_hash_str, &(image_sha256_))) { |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 120 | LOG(ERROR) << "Could not convert image hash to bytes."; |
| 121 | return false; |
| 122 | } |
| 123 | |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 124 | const std::string* table_hash_str = |
| 125 | manifest_dict.FindStringKey(kTableHashField); |
| 126 | if (table_hash_str == nullptr) { |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 127 | LOG(ERROR) << "Could not parse table hash from manifest."; |
| 128 | return false; |
| 129 | } |
| 130 | |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 131 | if (!GetSHA256FromString(*table_hash_str, &(table_sha256_))) { |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 132 | LOG(ERROR) << "Could not convert table hash to bytes."; |
| 133 | return false; |
| 134 | } |
| 135 | |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 136 | const std::string* version = manifest_dict.FindStringKey(kVersionField); |
| 137 | if (!version) { |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 138 | LOG(ERROR) << "Could not parse component version from manifest."; |
| 139 | return false; |
| 140 | } |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 141 | version_ = *version; |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 142 | |
| 143 | // The fs_type field is optional, and squashfs by default. |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 144 | const std::string* fs_type = manifest_dict.FindStringKey(kFSType); |
| 145 | if (fs_type) { |
| 146 | if (*fs_type == "ext4") { |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 147 | fs_type_ = FileSystem::kExt4; |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 148 | } else if (*fs_type == "squashfs") { |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 149 | fs_type_ = FileSystem::kSquashFS; |
| 150 | } else { |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 151 | LOG(ERROR) << "Unsupported file system type: " << *fs_type; |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 152 | return false; |
| 153 | } |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 154 | } else { |
| 155 | fs_type_ = FileSystem::kSquashFS; |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 156 | } |
| 157 | |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 158 | base::Optional<bool> is_removable = |
| 159 | manifest_dict.FindBoolKey(kIsRemovableField); |
| 160 | // If |is-removable| field does not exist, by default it is false. |
| 161 | is_removable_ = is_removable.value_or(false); |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 162 | |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 163 | base::Optional<bool> preload_allowed = |
| 164 | manifest_dict.FindBoolKey(kPreloadAllowed); |
| 165 | // If |preaload-allowed| field does not exist, by default it is false. |
| 166 | preload_allowed_ = preload_allowed.value_or(false); |
Jae Hoon Kim | 81d2b6d | 2020-01-06 16:09:32 -0800 | [diff] [blame] | 167 | |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 168 | base::Optional<bool> mount_file_required = |
| 169 | manifest_dict.FindBoolKey(kMountFileRequired); |
| 170 | // If 'mount-file-required' field does not exist, by default it is false. |
| 171 | mount_file_required_ = mount_file_required.value_or(false); |
Jae Hoon Kim | 99ee273 | 2020-06-25 15:59:35 -0700 | [diff] [blame] | 172 | |
Colin Howes | dc15ba2 | 2018-12-12 11:02:42 -0800 | [diff] [blame] | 173 | // All of these fields are optional. |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 174 | const std::string* id = manifest_dict.FindStringKey(kId); |
| 175 | if (id) |
| 176 | id_ = *id; |
| 177 | const std::string* package = manifest_dict.FindStringKey(kPackage); |
| 178 | if (package) |
| 179 | package_ = *package; |
| 180 | const std::string* name = manifest_dict.FindStringKey(kName); |
| 181 | if (name) |
| 182 | name_ = *name; |
| 183 | const std::string* image_type = manifest_dict.FindStringKey(kImageType); |
| 184 | if (image_type) |
| 185 | image_type_ = *image_type; |
| 186 | const std::string* used_by = manifest_dict.FindStringKey(kUsedBy); |
| 187 | if (used_by) |
| 188 | used_by_ = *used_by; |
| 189 | const std::string* description = manifest_dict.FindStringKey(kDescription); |
| 190 | if (description) |
| 191 | description_ = *description; |
Jae Hoon Kim | 9c012ac | 2020-02-03 17:37:49 -0800 | [diff] [blame] | 192 | |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 193 | const std::string* preallocated_size_str = |
| 194 | manifest_dict.FindStringKey(kPreallocatedSize); |
| 195 | if (preallocated_size_str) { |
| 196 | if (!base::StringToInt64(*preallocated_size_str, &preallocated_size_)) { |
Jae Hoon Kim | 9c012ac | 2020-02-03 17:37:49 -0800 | [diff] [blame] | 197 | LOG(ERROR) << "Manifest pre-allocated-size was malformed: " |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 198 | << *preallocated_size_str; |
Jae Hoon Kim | 9c012ac | 2020-02-03 17:37:49 -0800 | [diff] [blame] | 199 | return false; |
| 200 | } |
| 201 | } |
| 202 | |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 203 | const std::string* size_str = manifest_dict.FindStringKey(kSize); |
| 204 | if (size_str) { |
| 205 | if (!base::StringToInt64(*size_str, &size_)) { |
| 206 | LOG(ERROR) << "Manifest size was malformed: " << *size_str; |
Jae Hoon Kim | 9c012ac | 2020-02-03 17:37:49 -0800 | [diff] [blame] | 207 | return false; |
| 208 | } |
| 209 | } |
Colin Howes | dc15ba2 | 2018-12-12 11:02:42 -0800 | [diff] [blame] | 210 | |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 211 | // Copy out the metadata, if it's there. |
hscham | 1574c7e | 2020-10-13 12:40:01 +0900 | [diff] [blame] | 212 | const base::Value* metadata = manifest_dict.FindKey(kMetadataField); |
| 213 | if (metadata) { |
| 214 | if (!ParseMetadata(*metadata, &metadata_)) { |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 215 | LOG(ERROR) << "Manifest metadata was malformed"; |
| 216 | return false; |
| 217 | } |
| 218 | } |
| 219 | |
| 220 | return true; |
| 221 | } |
| 222 | |
Xiaochu Liu | cc7ff8c | 2018-07-23 11:54:02 -0700 | [diff] [blame] | 223 | } // namespace imageloader |