blob: 1dc9ff441de87d95c5c3121e6f1d37dcfcbec65f [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
24
25/*
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;
Joel Hutton69931af2019-03-11 11:37:38 +000032 const auth_method_desc_t *const img_auth_methods;
33 const auth_param_desc_t *const authenticated_data;
Juan Castillo8e55d932015-04-02 09:48:16 +010034} auth_img_desc_t;
35
36/* Public functions */
37void auth_mod_init(void);
38int auth_mod_get_parent_id(unsigned int img_id, unsigned int *parent_id);
39int auth_mod_verify_img(unsigned int img_id,
40 void *img_ptr,
41 unsigned int img_len);
42
Joel Huttone9919bb2019-02-20 11:56:46 +000043/* Macro to register a CoT defined as an array of auth_img_desc_t pointers */
Juan Castillo8e55d932015-04-02 09:48:16 +010044#define REGISTER_COT(_cot) \
Sandrine Bailleux25532c72019-06-07 14:33:51 +020045 const auth_img_desc_t *const *const cot_desc_ptr = (_cot); \
Sandrine Bailleux4bca1402020-03-25 11:22:34 +010046 const size_t cot_desc_size = ARRAY_SIZE(_cot); \
Roberto Vargasbe126ed2018-02-12 12:36:17 +000047 unsigned int auth_img_flags[MAX_NUMBER_IDS]
Juan Castillo8e55d932015-04-02 09:48:16 +010048
Sandrine Bailleux25532c72019-06-07 14:33:51 +020049extern const auth_img_desc_t *const *const cot_desc_ptr;
Sandrine Bailleux4bca1402020-03-25 11:22:34 +010050extern const size_t cot_desc_size;
Roberto Vargas52f707f2018-02-12 12:36:17 +000051extern unsigned int auth_img_flags[MAX_NUMBER_IDS];
52
Juan Castillo8e55d932015-04-02 09:48:16 +010053#endif /* TRUSTED_BOARD_BOOT */
54
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +000055#endif /* AUTH_MOD_H */