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_HASH_DESCRIPTOR_H_ 32 #define AVB_HASH_DESCRIPTOR_H_ 33 34 #include <android_avb/avb_descriptor.h> 35 36 #ifdef __cplusplus 37 extern "C" { 38 #endif 39 40 /* Flags for hash descriptors. 41 * 42 * AVB_HASH_DESCRIPTOR_FLAGS_DO_NOT_USE_AB: Do not apply the default A/B 43 * partition logic to this partition. This is intentionally a negative boolean 44 * because A/B should be both the default and most used in practice. 45 */ 46 typedef enum { 47 AVB_HASH_DESCRIPTOR_FLAGS_DO_NOT_USE_AB = (1 << 0), 48 } AvbHashDescriptorFlags; 49 50 /* A descriptor containing information about hash for an image. 51 * 52 * This descriptor is typically used for boot partitions to verify the 53 * entire kernel+initramfs image before executing it. 54 * 55 * Following this struct are |partition_name_len| bytes of the 56 * partition name (UTF-8 encoded), |salt_len| bytes of salt, and then 57 * |digest_len| bytes of the digest. 58 * 59 * The |reserved| field is for future expansion and must be set to NUL 60 * bytes. 61 * 62 * Changes in v1.1: 63 * - flags field is added which supports AVB_HASH_DESCRIPTOR_FLAGS_USE_AB 64 * - digest_len may be zero, which indicates the use of a persistent digest 65 */ 66 typedef struct AvbHashDescriptor { 67 AvbDescriptor parent_descriptor; 68 uint64_t image_size; 69 uint8_t hash_algorithm[32]; 70 uint32_t partition_name_len; 71 uint32_t salt_len; 72 uint32_t digest_len; 73 uint32_t flags; 74 uint8_t reserved[60]; 75 } AVB_ATTR_PACKED AvbHashDescriptor; 76 77 /* Copies |src| to |dest| and validates, byte-swapping fields in the 78 * process if needed. Returns true if valid, false if invalid. 79 * 80 * Data following the struct is not validated nor copied. 81 */ 82 bool avb_hash_descriptor_validate_and_byteswap(const AvbHashDescriptor* src, 83 AvbHashDescriptor* dest) 84 AVB_ATTR_WARN_UNUSED_RESULT; 85 86 #ifdef __cplusplus 87 } 88 #endif 89 90 #endif /* AVB_HASH_DESCRIPTOR_H_ */ 91