blob: 73b2b998cb0b1e00a875ccf5ef5bdb5df9f2ffb3 [file] [log] [blame]
Juan Castillo8e55d932015-04-02 09:48:16 +01001/*
Manish V Badarkhe92de80a2021-12-16 10:41:47 +00002 * Copyright (c) 2015-2022, 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 CRYPTO_MOD_H
8#define CRYPTO_MOD_H
Juan Castillo8e55d932015-04-02 09:48:16 +01009
10/* Return values */
11enum crypto_ret_value {
12 CRYPTO_SUCCESS = 0,
13 CRYPTO_ERR_INIT,
14 CRYPTO_ERR_HASH,
15 CRYPTO_ERR_SIGNATURE,
Sumit Garg392e4df2019-11-15 10:43:00 +053016 CRYPTO_ERR_DECRYPTION,
Juan Castillo8e55d932015-04-02 09:48:16 +010017 CRYPTO_ERR_UNKNOWN
18};
19
Sumit Garg392e4df2019-11-15 10:43:00 +053020#define CRYPTO_MAX_IV_SIZE 16U
21#define CRYPTO_MAX_TAG_SIZE 16U
22
23/* Decryption algorithm */
24enum crypto_dec_algo {
25 CRYPTO_GCM_DECRYPT = 0
26};
27
Manish V Badarkhee112a5a2021-10-06 23:41:50 +010028/* Message digest algorithm */
29enum crypto_md_algo {
30 CRYPTO_MD_SHA256,
31 CRYPTO_MD_SHA384,
32 CRYPTO_MD_SHA512,
33};
34
35/* Maximum size as per the known stronger hash algorithm i.e.SHA512 */
36#define CRYPTO_MD_MAX_SIZE 64U
37
Juan Castillo8e55d932015-04-02 09:48:16 +010038/*
39 * Cryptographic library descriptor
40 */
41typedef struct crypto_lib_desc_s {
42 const char *name;
43
44 /* Initialize library. This function is not expected to fail. All errors
45 * must be handled inside the function, asserting or panicing in case of
46 * a non-recoverable error */
47 void (*init)(void);
48
49 /* Verify a digital signature. Return one of the
50 * 'enum crypto_ret_value' options */
51 int (*verify_signature)(void *data_ptr, unsigned int data_len,
52 void *sig_ptr, unsigned int sig_len,
53 void *sig_alg, unsigned int sig_alg_len,
54 void *pk_ptr, unsigned int pk_len);
55
56 /* Verify a hash. Return one of the 'enum crypto_ret_value' options */
57 int (*verify_hash)(void *data_ptr, unsigned int data_len,
58 void *digest_info_ptr, unsigned int digest_info_len);
Alexei Fedorov913cb7e2020-01-23 14:27:38 +000059
60#if MEASURED_BOOT
61 /* Calculate a hash. Return hash value */
Manish V Badarkhee112a5a2021-10-06 23:41:50 +010062 int (*calc_hash)(enum crypto_md_algo md_alg, void *data_ptr,
63 unsigned int data_len,
64 unsigned char output[CRYPTO_MD_MAX_SIZE]);
Alexei Fedorov913cb7e2020-01-23 14:27:38 +000065#endif /* MEASURED_BOOT */
66
Sumit Garg392e4df2019-11-15 10:43:00 +053067 /*
68 * Authenticated decryption. Return one of the
69 * 'enum crypto_ret_value' options.
70 */
71 int (*auth_decrypt)(enum crypto_dec_algo dec_algo, void *data_ptr,
72 size_t len, const void *key, unsigned int key_len,
73 unsigned int key_flags, const void *iv,
74 unsigned int iv_len, const void *tag,
75 unsigned int tag_len);
Juan Castillo8e55d932015-04-02 09:48:16 +010076} crypto_lib_desc_t;
77
78/* Public functions */
Manish V Badarkhe92de80a2021-12-16 10:41:47 +000079#if CRYPTO_SUPPORT
Juan Castillo8e55d932015-04-02 09:48:16 +010080void crypto_mod_init(void);
Manish V Badarkhe92de80a2021-12-16 10:41:47 +000081#else
82static inline void crypto_mod_init(void)
83{
84}
85#endif /* CRYPTO_SUPPORT */
86
Juan Castillo8e55d932015-04-02 09:48:16 +010087int crypto_mod_verify_signature(void *data_ptr, unsigned int data_len,
88 void *sig_ptr, unsigned int sig_len,
Roberto Vargasbe126ed2018-02-12 12:36:17 +000089 void *sig_alg_ptr, unsigned int sig_alg_len,
Juan Castillo8e55d932015-04-02 09:48:16 +010090 void *pk_ptr, unsigned int pk_len);
91int crypto_mod_verify_hash(void *data_ptr, unsigned int data_len,
92 void *digest_info_ptr, unsigned int digest_info_len);
Sumit Garg392e4df2019-11-15 10:43:00 +053093int crypto_mod_auth_decrypt(enum crypto_dec_algo dec_algo, void *data_ptr,
94 size_t len, const void *key, unsigned int key_len,
95 unsigned int key_flags, const void *iv,
96 unsigned int iv_len, const void *tag,
97 unsigned int tag_len);
Juan Castillo8e55d932015-04-02 09:48:16 +010098
Alexei Fedorov913cb7e2020-01-23 14:27:38 +000099#if MEASURED_BOOT
Manish V Badarkhee112a5a2021-10-06 23:41:50 +0100100int crypto_mod_calc_hash(enum crypto_md_algo alg, void *data_ptr,
101 unsigned int data_len,
102 unsigned char output[CRYPTO_MD_MAX_SIZE]);
Manish V Badarkhe92de80a2021-12-16 10:41:47 +0000103#endif /* MEASURED_BOOT */
Alexei Fedorov913cb7e2020-01-23 14:27:38 +0000104
Manish V Badarkhe92de80a2021-12-16 10:41:47 +0000105#if MEASURED_BOOT && TRUSTED_BOARD_BOOT
Juan Castillo8e55d932015-04-02 09:48:16 +0100106/* Macro to register a cryptographic library */
Alexei Fedorov913cb7e2020-01-23 14:27:38 +0000107#define REGISTER_CRYPTO_LIB(_name, _init, _verify_signature, _verify_hash, \
Sumit Garg392e4df2019-11-15 10:43:00 +0530108 _calc_hash, _auth_decrypt) \
Alexei Fedorov913cb7e2020-01-23 14:27:38 +0000109 const crypto_lib_desc_t crypto_lib_desc = { \
110 .name = _name, \
111 .init = _init, \
112 .verify_signature = _verify_signature, \
113 .verify_hash = _verify_hash, \
Sumit Garg392e4df2019-11-15 10:43:00 +0530114 .calc_hash = _calc_hash, \
115 .auth_decrypt = _auth_decrypt \
Alexei Fedorov913cb7e2020-01-23 14:27:38 +0000116 }
Manish V Badarkhe92de80a2021-12-16 10:41:47 +0000117#elif TRUSTED_BOARD_BOOT
Sumit Garg392e4df2019-11-15 10:43:00 +0530118#define REGISTER_CRYPTO_LIB(_name, _init, _verify_signature, _verify_hash, \
119 _auth_decrypt) \
Juan Castillo8e55d932015-04-02 09:48:16 +0100120 const crypto_lib_desc_t crypto_lib_desc = { \
121 .name = _name, \
122 .init = _init, \
123 .verify_signature = _verify_signature, \
Sumit Garg392e4df2019-11-15 10:43:00 +0530124 .verify_hash = _verify_hash, \
125 .auth_decrypt = _auth_decrypt \
Juan Castillo8e55d932015-04-02 09:48:16 +0100126 }
Manish V Badarkhe92de80a2021-12-16 10:41:47 +0000127#elif MEASURED_BOOT
128#define REGISTER_CRYPTO_LIB(_name, _init, _calc_hash) \
129 const crypto_lib_desc_t crypto_lib_desc = { \
130 .name = _name, \
131 .init = _init, \
132 .calc_hash = _calc_hash, \
133 }
134#endif /* MEASURED_BOOT && TRUSTED_BOARD_BOOT */
Juan Castillo8e55d932015-04-02 09:48:16 +0100135
Roberto Vargas52f707f2018-02-12 12:36:17 +0000136extern const crypto_lib_desc_t crypto_lib_desc;
137
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +0000138#endif /* CRYPTO_MOD_H */