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 #if !defined(AVB_INSIDE_LIBAVB_H) && !defined(AVB_COMPILATION)
26 #error "Never include this file directly, include libavb.h instead."
27 #endif
28 
29 #ifndef AVB_CHAIN_PARTITION_DESCRIPTOR_H_
30 #define AVB_CHAIN_PARTITION_DESCRIPTOR_H_
31 
32 #include "avb_descriptor.h"
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 /* A descriptor containing a pointer to signed integrity data stored
39  * on another partition. The descriptor contains the partition name in
40  * question (without the A/B suffix), the public key used to sign the
41  * integrity data, and rollback index location to use for rollback
42  * protection.
43  *
44  * Following this struct are |partition_name_len| bytes of the
45  * partition name (UTF-8 encoded) and |public_key_len| bytes of the
46  * public key.
47  *
48  * The |reserved| field is for future expansion and must be set to NUL
49  * bytes.
50  */
51 typedef struct AvbChainPartitionDescriptor {
52   AvbDescriptor parent_descriptor;
53   uint32_t rollback_index_location;
54   uint32_t partition_name_len;
55   uint32_t public_key_len;
56   uint8_t reserved[64];
57 } AVB_ATTR_PACKED AvbChainPartitionDescriptor;
58 
59 /* Copies |src| to |dest| and validates, byte-swapping fields in the
60  * process if needed. Returns true if valid, false if invalid.
61  *
62  * Data following the struct is not validated nor copied.
63  */
64 bool avb_chain_partition_descriptor_validate_and_byteswap(
65     const AvbChainPartitionDescriptor* src,
66     AvbChainPartitionDescriptor* dest) AVB_ATTR_WARN_UNUSED_RESULT;
67 
68 #ifdef __cplusplus
69 }
70 #endif
71 
72 #endif /* AVB_CHAIN_PARTITION_DESCRIPTOR_H_ */
73