1*4882a593Smuzhiyun /* 2*4882a593Smuzhiyun * Copyright (C) 2016 The Android Open Source Project 3*4882a593Smuzhiyun * 4*4882a593Smuzhiyun * Permission is hereby granted, free of charge, to any person 5*4882a593Smuzhiyun * obtaining a copy of this software and associated documentation 6*4882a593Smuzhiyun * files (the "Software"), to deal in the Software without 7*4882a593Smuzhiyun * restriction, including without limitation the rights to use, copy, 8*4882a593Smuzhiyun * modify, merge, publish, distribute, sublicense, and/or sell copies 9*4882a593Smuzhiyun * of the Software, and to permit persons to whom the Software is 10*4882a593Smuzhiyun * furnished to do so, subject to the following conditions: 11*4882a593Smuzhiyun * 12*4882a593Smuzhiyun * The above copyright notice and this permission notice shall be 13*4882a593Smuzhiyun * included in all copies or substantial portions of the Software. 14*4882a593Smuzhiyun * 15*4882a593Smuzhiyun * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 16*4882a593Smuzhiyun * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 17*4882a593Smuzhiyun * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 18*4882a593Smuzhiyun * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 19*4882a593Smuzhiyun * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 20*4882a593Smuzhiyun * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 21*4882a593Smuzhiyun * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22*4882a593Smuzhiyun * SOFTWARE. 23*4882a593Smuzhiyun */ 24*4882a593Smuzhiyun 25*4882a593Smuzhiyun /* 26*4882a593Smuzhiyun #if !defined(AVB_INSIDE_LIBAVB_H) && !defined(AVB_COMPILATION) 27*4882a593Smuzhiyun #error "Never include this file directly, include libavb.h instead." 28*4882a593Smuzhiyun #endif 29*4882a593Smuzhiyun */ 30*4882a593Smuzhiyun 31*4882a593Smuzhiyun #ifndef AVB_HASH_DESCRIPTOR_H_ 32*4882a593Smuzhiyun #define AVB_HASH_DESCRIPTOR_H_ 33*4882a593Smuzhiyun 34*4882a593Smuzhiyun #include <android_avb/avb_descriptor.h> 35*4882a593Smuzhiyun 36*4882a593Smuzhiyun #ifdef __cplusplus 37*4882a593Smuzhiyun extern "C" { 38*4882a593Smuzhiyun #endif 39*4882a593Smuzhiyun 40*4882a593Smuzhiyun /* Flags for hash descriptors. 41*4882a593Smuzhiyun * 42*4882a593Smuzhiyun * AVB_HASH_DESCRIPTOR_FLAGS_DO_NOT_USE_AB: Do not apply the default A/B 43*4882a593Smuzhiyun * partition logic to this partition. This is intentionally a negative boolean 44*4882a593Smuzhiyun * because A/B should be both the default and most used in practice. 45*4882a593Smuzhiyun */ 46*4882a593Smuzhiyun typedef enum { 47*4882a593Smuzhiyun AVB_HASH_DESCRIPTOR_FLAGS_DO_NOT_USE_AB = (1 << 0), 48*4882a593Smuzhiyun } AvbHashDescriptorFlags; 49*4882a593Smuzhiyun 50*4882a593Smuzhiyun /* A descriptor containing information about hash for an image. 51*4882a593Smuzhiyun * 52*4882a593Smuzhiyun * This descriptor is typically used for boot partitions to verify the 53*4882a593Smuzhiyun * entire kernel+initramfs image before executing it. 54*4882a593Smuzhiyun * 55*4882a593Smuzhiyun * Following this struct are |partition_name_len| bytes of the 56*4882a593Smuzhiyun * partition name (UTF-8 encoded), |salt_len| bytes of salt, and then 57*4882a593Smuzhiyun * |digest_len| bytes of the digest. 58*4882a593Smuzhiyun * 59*4882a593Smuzhiyun * The |reserved| field is for future expansion and must be set to NUL 60*4882a593Smuzhiyun * bytes. 61*4882a593Smuzhiyun * 62*4882a593Smuzhiyun * Changes in v1.1: 63*4882a593Smuzhiyun * - flags field is added which supports AVB_HASH_DESCRIPTOR_FLAGS_USE_AB 64*4882a593Smuzhiyun * - digest_len may be zero, which indicates the use of a persistent digest 65*4882a593Smuzhiyun */ 66*4882a593Smuzhiyun typedef struct AvbHashDescriptor { 67*4882a593Smuzhiyun AvbDescriptor parent_descriptor; 68*4882a593Smuzhiyun uint64_t image_size; 69*4882a593Smuzhiyun uint8_t hash_algorithm[32]; 70*4882a593Smuzhiyun uint32_t partition_name_len; 71*4882a593Smuzhiyun uint32_t salt_len; 72*4882a593Smuzhiyun uint32_t digest_len; 73*4882a593Smuzhiyun uint32_t flags; 74*4882a593Smuzhiyun uint8_t reserved[60]; 75*4882a593Smuzhiyun } AVB_ATTR_PACKED AvbHashDescriptor; 76*4882a593Smuzhiyun 77*4882a593Smuzhiyun /* Copies |src| to |dest| and validates, byte-swapping fields in the 78*4882a593Smuzhiyun * process if needed. Returns true if valid, false if invalid. 79*4882a593Smuzhiyun * 80*4882a593Smuzhiyun * Data following the struct is not validated nor copied. 81*4882a593Smuzhiyun */ 82*4882a593Smuzhiyun bool avb_hash_descriptor_validate_and_byteswap(const AvbHashDescriptor* src, 83*4882a593Smuzhiyun AvbHashDescriptor* dest) 84*4882a593Smuzhiyun AVB_ATTR_WARN_UNUSED_RESULT; 85*4882a593Smuzhiyun 86*4882a593Smuzhiyun #ifdef __cplusplus 87*4882a593Smuzhiyun } 88*4882a593Smuzhiyun #endif 89*4882a593Smuzhiyun 90*4882a593Smuzhiyun #endif /* AVB_HASH_DESCRIPTOR_H_ */ 91