105799ae0SJuan Castillo /*
2*a8eadc51SGovindraj Raja * Copyright (c) 2015-2023, ARM Limited and Contributors. All rights reserved.
305799ae0SJuan Castillo *
482cb2c1aSdp-arm * SPDX-License-Identifier: BSD-3-Clause
505799ae0SJuan Castillo */
605799ae0SJuan Castillo
7c3cf06f1SAntonio Nino Diaz #ifndef AUTH_MOD_H
8c3cf06f1SAntonio Nino Diaz #define AUTH_MOD_H
905799ae0SJuan Castillo
1009d40e0eSAntonio Nino Diaz #include <common/tbbr/tbbr_img_def.h>
1109d40e0eSAntonio Nino Diaz #include <drivers/auth/auth_common.h>
1209d40e0eSAntonio Nino Diaz #include <drivers/auth/img_parser_mod.h>
1305799ae0SJuan Castillo
146f8a2565SSandrine Bailleux #include <lib/utils_def.h>
156f8a2565SSandrine Bailleux
1605799ae0SJuan Castillo /*
1705799ae0SJuan Castillo * Image flags
1805799ae0SJuan Castillo */
1905799ae0SJuan Castillo #define IMG_FLAG_AUTHENTICATED (1 << 0)
2005799ae0SJuan Castillo
2128e9a55fSManish V Badarkhe #if COT_DESC_IN_DTB && !IMAGE_BL1
2228e9a55fSManish V Badarkhe /*
2328e9a55fSManish V Badarkhe * Authentication image descriptor
2428e9a55fSManish V Badarkhe */
2528e9a55fSManish V Badarkhe typedef struct auth_img_desc_s {
2628e9a55fSManish V Badarkhe unsigned int img_id;
2728e9a55fSManish V Badarkhe img_type_t img_type;
2828e9a55fSManish V Badarkhe const struct auth_img_desc_s *parent;
2928e9a55fSManish V Badarkhe auth_method_desc_t *img_auth_methods;
3028e9a55fSManish V Badarkhe auth_param_desc_t *authenticated_data;
3128e9a55fSManish V Badarkhe } auth_img_desc_t;
3228e9a55fSManish V Badarkhe #else
3305799ae0SJuan Castillo /*
3405799ae0SJuan Castillo * Authentication image descriptor
3505799ae0SJuan Castillo */
3605799ae0SJuan Castillo typedef struct auth_img_desc_s {
3705799ae0SJuan Castillo unsigned int img_id;
3805799ae0SJuan Castillo img_type_t img_type;
39b313d755SSoby Mathew const struct auth_img_desc_s *parent;
4030070427SJoel Hutton const auth_method_desc_t *const img_auth_methods;
4130070427SJoel Hutton const auth_param_desc_t *const authenticated_data;
4205799ae0SJuan Castillo } auth_img_desc_t;
4328e9a55fSManish V Badarkhe #endif /* COT_DESC_IN_DTB && !IMAGE_BL1 */
4405799ae0SJuan Castillo
4505799ae0SJuan Castillo /* Public functions */
460aa0b3afSManish V Badarkhe #if TRUSTED_BOARD_BOOT
4705799ae0SJuan Castillo void auth_mod_init(void);
480aa0b3afSManish V Badarkhe #else
auth_mod_init(void)490aa0b3afSManish V Badarkhe static inline void auth_mod_init(void)
500aa0b3afSManish V Badarkhe {
510aa0b3afSManish V Badarkhe }
520aa0b3afSManish V Badarkhe #endif /* TRUSTED_BOARD_BOOT */
5305799ae0SJuan Castillo int auth_mod_get_parent_id(unsigned int img_id, unsigned int *parent_id);
5405799ae0SJuan Castillo int auth_mod_verify_img(unsigned int img_id,
5505799ae0SJuan Castillo void *img_ptr,
5605799ae0SJuan Castillo unsigned int img_len);
5705799ae0SJuan Castillo
580b6377d1SJoel Hutton /* Macro to register a CoT defined as an array of auth_img_desc_t pointers */
5905799ae0SJuan Castillo #define REGISTER_COT(_cot) \
602efb7ddcSSandrine Bailleux const auth_img_desc_t *const *const cot_desc_ptr = (_cot); \
616f8a2565SSandrine Bailleux const size_t cot_desc_size = ARRAY_SIZE(_cot); \
62735181b6SRoberto Vargas unsigned int auth_img_flags[MAX_NUMBER_IDS]
6305799ae0SJuan Castillo
642efb7ddcSSandrine Bailleux extern const auth_img_desc_t *const *const cot_desc_ptr;
656f8a2565SSandrine Bailleux extern const size_t cot_desc_size;
663b94189aSRoberto Vargas extern unsigned int auth_img_flags[MAX_NUMBER_IDS];
673b94189aSRoberto Vargas
6844f1aa8eSManish Pandey #if defined(SPD_spmd)
692947412dSManish Pandey
702947412dSManish Pandey #define DEFINE_SIP_SP_PKG(n) DEFINE_SP_PKG(n, sip_sp_content_cert)
712947412dSManish Pandey #define DEFINE_PLAT_SP_PKG(n) DEFINE_SP_PKG(n, plat_sp_content_cert)
722947412dSManish Pandey
732947412dSManish Pandey #define DEFINE_SP_PKG(n, cert) \
7444f1aa8eSManish Pandey static const auth_img_desc_t sp_pkg##n = { \
7503a5225cSManish Pandey .img_id = SP_PKG##n##_ID, \
7644f1aa8eSManish Pandey .img_type = IMG_RAW, \
772947412dSManish Pandey .parent = &cert, \
7844f1aa8eSManish Pandey .img_auth_methods = (const auth_method_desc_t[AUTH_METHOD_NUM]) { \
7944f1aa8eSManish Pandey [0] = { \
8044f1aa8eSManish Pandey .type = AUTH_METHOD_HASH, \
8144f1aa8eSManish Pandey .param.hash = { \
8244f1aa8eSManish Pandey .data = &raw_data, \
8344f1aa8eSManish Pandey .hash = &sp_pkg##n##_hash \
8444f1aa8eSManish Pandey } \
8544f1aa8eSManish Pandey } \
8644f1aa8eSManish Pandey } \
8744f1aa8eSManish Pandey }
882947412dSManish Pandey
8944f1aa8eSManish Pandey #endif
9044f1aa8eSManish Pandey
91c3cf06f1SAntonio Nino Diaz #endif /* AUTH_MOD_H */
92