xref: /rk3399_ARM-atf/include/drivers/auth/auth_mod.h (revision 51faada71a219a8b94cd8d8e423f0f22e9da4d8f)
1 /*
2  * Copyright (c) 2015, ARM Limited and Contributors. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * Neither the name of ARM nor the names of its contributors may be used
15  * to endorse or promote products derived from this software without specific
16  * prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #ifndef __AUTH_MOD_H__
32 #define __AUTH_MOD_H__
33 
34 #if TRUSTED_BOARD_BOOT
35 
36 #include <auth_common.h>
37 #include <cot_def.h>
38 #include <img_parser_mod.h>
39 
40 /*
41  * Image flags
42  */
43 #define IMG_FLAG_AUTHENTICATED		(1 << 0)
44 
45 
46 /*
47  * Authentication image descriptor
48  */
49 typedef struct auth_img_desc_s {
50 	unsigned int img_id;
51 	img_type_t img_type;
52 	const struct auth_img_desc_s *parent;
53 	auth_method_desc_t img_auth_methods[AUTH_METHOD_NUM];
54 	auth_param_desc_t authenticated_data[COT_MAX_VERIFIED_PARAMS];
55 } auth_img_desc_t;
56 
57 /* Public functions */
58 void auth_mod_init(void);
59 int auth_mod_get_parent_id(unsigned int img_id, unsigned int *parent_id);
60 int auth_mod_verify_img(unsigned int img_id,
61 			void *img_ptr,
62 			unsigned int img_len);
63 
64 /* Macro to register a CoT defined as an array of auth_img_desc_t */
65 #define REGISTER_COT(_cot) \
66 	const auth_img_desc_t *const cot_desc_ptr = \
67 			(const auth_img_desc_t *const)&_cot[0]; \
68 	unsigned int auth_img_flags[sizeof(_cot)/sizeof(_cot[0])]
69 
70 #endif /* TRUSTED_BOARD_BOOT */
71 
72 #endif /* __AUTH_MOD_H__ */
73