blob: d1fd52c86869e7c4d2f1b6245c434b986199e186 [file] [log] [blame]
Juan Castillo8e55d932015-04-02 09:48:16 +01001/*
Sandrine Bailleux4bca1402020-03-25 11:22:34 +01002 * Copyright (c) 2015-2020, ARM Limited and Contributors. All rights reserved.
Juan Castillo8e55d932015-04-02 09:48:16 +01003 *
dp-armfa3cf0b2017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Juan Castillo8e55d932015-04-02 09:48:16 +01005 */
6
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +00007#ifndef AUTH_MOD_H
8#define AUTH_MOD_H
Juan Castillo8e55d932015-04-02 09:48:16 +01009
10#if TRUSTED_BOARD_BOOT
11
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000012#include <common/tbbr/cot_def.h>
13#include <common/tbbr/tbbr_img_def.h>
14#include <drivers/auth/auth_common.h>
15#include <drivers/auth/img_parser_mod.h>
Juan Castillo8e55d932015-04-02 09:48:16 +010016
Sandrine Bailleux4bca1402020-03-25 11:22:34 +010017#include <lib/utils_def.h>
18
Juan Castillo8e55d932015-04-02 09:48:16 +010019/*
20 * Image flags
21 */
22#define IMG_FLAG_AUTHENTICATED (1 << 0)
23
Manish V Badarkhe39317ab2020-07-23 10:43:57 +010024#if COT_DESC_IN_DTB && !IMAGE_BL1
Juan Castillo8e55d932015-04-02 09:48:16 +010025/*
26 * Authentication image descriptor
27 */
28typedef struct auth_img_desc_s {
29 unsigned int img_id;
Juan Castillo8e55d932015-04-02 09:48:16 +010030 img_type_t img_type;
Soby Mathew6d4f2622016-01-12 10:30:59 +000031 const struct auth_img_desc_s *parent;
Manish V Badarkhe39317ab2020-07-23 10:43:57 +010032 auth_method_desc_t *img_auth_methods;
33 auth_param_desc_t *authenticated_data;
34} auth_img_desc_t;
35#else
36/*
37 * Authentication image descriptor
38 */
39typedef struct auth_img_desc_s {
40 unsigned int img_id;
41 img_type_t img_type;
42 const struct auth_img_desc_s *parent;
Joel Hutton69931af2019-03-11 11:37:38 +000043 const auth_method_desc_t *const img_auth_methods;
44 const auth_param_desc_t *const authenticated_data;
Juan Castillo8e55d932015-04-02 09:48:16 +010045} auth_img_desc_t;
Manish V Badarkhe39317ab2020-07-23 10:43:57 +010046#endif /* COT_DESC_IN_DTB && !IMAGE_BL1 */
Juan Castillo8e55d932015-04-02 09:48:16 +010047
48/* Public functions */
49void auth_mod_init(void);
50int auth_mod_get_parent_id(unsigned int img_id, unsigned int *parent_id);
51int auth_mod_verify_img(unsigned int img_id,
52 void *img_ptr,
53 unsigned int img_len);
54
Joel Huttone9919bb2019-02-20 11:56:46 +000055/* Macro to register a CoT defined as an array of auth_img_desc_t pointers */
Juan Castillo8e55d932015-04-02 09:48:16 +010056#define REGISTER_COT(_cot) \
Sandrine Bailleux25532c72019-06-07 14:33:51 +020057 const auth_img_desc_t *const *const cot_desc_ptr = (_cot); \
Sandrine Bailleux4bca1402020-03-25 11:22:34 +010058 const size_t cot_desc_size = ARRAY_SIZE(_cot); \
Roberto Vargasbe126ed2018-02-12 12:36:17 +000059 unsigned int auth_img_flags[MAX_NUMBER_IDS]
Juan Castillo8e55d932015-04-02 09:48:16 +010060
Sandrine Bailleux25532c72019-06-07 14:33:51 +020061extern const auth_img_desc_t *const *const cot_desc_ptr;
Sandrine Bailleux4bca1402020-03-25 11:22:34 +010062extern const size_t cot_desc_size;
Roberto Vargas52f707f2018-02-12 12:36:17 +000063extern unsigned int auth_img_flags[MAX_NUMBER_IDS];
64
Manish Pandey5f8e1a02020-05-27 22:40:10 +010065#if defined(SPD_spmd)
Manish Pandey6aef2cc2020-07-31 16:25:17 +010066
67#define DEFINE_SIP_SP_PKG(n) DEFINE_SP_PKG(n, sip_sp_content_cert)
68#define DEFINE_PLAT_SP_PKG(n) DEFINE_SP_PKG(n, plat_sp_content_cert)
69
70#define DEFINE_SP_PKG(n, cert) \
Manish Pandey5f8e1a02020-05-27 22:40:10 +010071 static const auth_img_desc_t sp_pkg##n = { \
Manish Pandeyd07d0172020-07-23 16:54:30 +010072 .img_id = SP_PKG##n##_ID, \
Manish Pandey5f8e1a02020-05-27 22:40:10 +010073 .img_type = IMG_RAW, \
Manish Pandey6aef2cc2020-07-31 16:25:17 +010074 .parent = &cert, \
Manish Pandey5f8e1a02020-05-27 22:40:10 +010075 .img_auth_methods = (const auth_method_desc_t[AUTH_METHOD_NUM]) { \
76 [0] = { \
77 .type = AUTH_METHOD_HASH, \
78 .param.hash = { \
79 .data = &raw_data, \
80 .hash = &sp_pkg##n##_hash \
81 } \
82 } \
83 } \
84 }
Manish Pandey6aef2cc2020-07-31 16:25:17 +010085
Manish Pandey5f8e1a02020-05-27 22:40:10 +010086#endif
87
Juan Castillo8e55d932015-04-02 09:48:16 +010088#endif /* TRUSTED_BOARD_BOOT */
89
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +000090#endif /* AUTH_MOD_H */