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 /* A descriptor containing information about hash for an image. 41 * 42 * This descriptor is typically used for boot partitions to verify the 43 * entire kernel+initramfs image before executing it. 44 * 45 * Following this struct are |partition_name_len| bytes of the 46 * partition name (UTF-8 encoded), |salt_len| bytes of salt, and then 47 * |digest_len| bytes of the digest. 48 * 49 * The |reserved| field is for future expansion and must be set to NUL 50 * bytes. 51 */ 52 typedef struct AvbHashDescriptor { 53 AvbDescriptor parent_descriptor; 54 uint64_t image_size; 55 uint8_t hash_algorithm[32]; 56 uint32_t partition_name_len; 57 uint32_t salt_len; 58 uint32_t digest_len; 59 uint8_t reserved[64]; 60 } AVB_ATTR_PACKED AvbHashDescriptor; 61 62 /* Copies |src| to |dest| and validates, byte-swapping fields in the 63 * process if needed. Returns true if valid, false if invalid. 64 * 65 * Data following the struct is not validated nor copied. 66 */ 67 bool avb_hash_descriptor_validate_and_byteswap(const AvbHashDescriptor* src, 68 AvbHashDescriptor* dest) 69 AVB_ATTR_WARN_UNUSED_RESULT; 70 71 #ifdef __cplusplus 72 } 73 #endif 74 75 #endif /* AVB_HASH_DESCRIPTOR_H_ */ 76