1 /* 2 * Copyright (C) 2016 The Android Open Source Project 3 * 4 * Permission is hereby granted, free of charge, to any person 5 * obtaining a copy of this software and associated documentation 6 * files (the "Software"), to deal in the Software without 7 * restriction, including without limitation the rights to use, copy, 8 * modify, merge, publish, distribute, sublicense, and/or sell copies 9 * of the Software, and to permit persons to whom the Software is 10 * furnished to do so, subject to the following conditions: 11 * 12 * The above copyright notice and this permission notice shall be 13 * included in all copies or substantial portions of the Software. 14 * 15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 18 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 19 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 20 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 21 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 * SOFTWARE. 23 */ 24 25 /* 26 #if !defined(AVB_INSIDE_LIBAVB_H) && !defined(AVB_COMPILATION) 27 #error "Never include this file directly, include libavb.h instead." 28 #endif 29 */ 30 31 #ifndef AVB_HASHTREE_DESCRIPTOR_H_ 32 #define AVB_HASHTREE_DESCRIPTOR_H_ 33 34 #include <android_avb/avb_descriptor.h> 35 36 #ifdef __cplusplus 37 extern "C" { 38 #endif 39 40 /* A descriptor containing information about a dm-verity hashtree. 41 * 42 * Hash-trees are used to verify large partitions typically containing 43 * file systems. See 44 * https://gitlab.com/cryptsetup/cryptsetup/wikis/DMVerity for more 45 * information about dm-verity. 46 * 47 * Following this struct are |partition_name_len| bytes of the 48 * partition name (UTF-8 encoded), |salt_len| bytes of salt, and then 49 * |root_digest_len| bytes of the root digest. 50 * 51 * The |reserved| field is for future expansion and must be set to NUL 52 * bytes. 53 */ 54 typedef struct AvbHashtreeDescriptor { 55 AvbDescriptor parent_descriptor; 56 uint32_t dm_verity_version; 57 uint64_t image_size; 58 uint64_t tree_offset; 59 uint64_t tree_size; 60 uint32_t data_block_size; 61 uint32_t hash_block_size; 62 uint32_t fec_num_roots; 63 uint64_t fec_offset; 64 uint64_t fec_size; 65 uint8_t hash_algorithm[32]; 66 uint32_t partition_name_len; 67 uint32_t salt_len; 68 uint32_t root_digest_len; 69 uint8_t reserved[64]; 70 } AVB_ATTR_PACKED AvbHashtreeDescriptor; 71 72 /* Copies |src| to |dest| and validates, byte-swapping fields in the 73 * process if needed. Returns true if valid, false if invalid. 74 * 75 * Data following the struct is not validated nor copied. 76 */ 77 bool avb_hashtree_descriptor_validate_and_byteswap( 78 const AvbHashtreeDescriptor* src, 79 AvbHashtreeDescriptor* dest) AVB_ATTR_WARN_UNUSED_RESULT; 80 81 #ifdef __cplusplus 82 } 83 #endif 84 85 #endif /* AVB_HASHTREE_DESCRIPTOR_H_ */ 86