blob: 00ea8c6208d71141f9c173c35e9c5f18f7b20ccc [file] [log] [blame]
Juan Castillo8e55d932015-04-02 09:48:16 +01001/*
Yann Gautierc68b8af2023-01-24 09:39:47 +01002 * Copyright (c) 2015-2023, 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
Manish V Badarkhec9fdaf62022-06-20 15:32:38 +010010#define CRYPTO_AUTH_VERIFY_ONLY 1
11#define CRYPTO_HASH_CALC_ONLY 2
12#define CRYPTO_AUTH_VERIFY_AND_HASH_CALC 3
13
Juan Castillo8e55d932015-04-02 09:48:16 +010014/* Return values */
15enum crypto_ret_value {
16 CRYPTO_SUCCESS = 0,
17 CRYPTO_ERR_INIT,
18 CRYPTO_ERR_HASH,
19 CRYPTO_ERR_SIGNATURE,
Sumit Garg392e4df2019-11-15 10:43:00 +053020 CRYPTO_ERR_DECRYPTION,
Juan Castillo8e55d932015-04-02 09:48:16 +010021 CRYPTO_ERR_UNKNOWN
22};
23
Sumit Garg392e4df2019-11-15 10:43:00 +053024#define CRYPTO_MAX_IV_SIZE 16U
25#define CRYPTO_MAX_TAG_SIZE 16U
26
27/* Decryption algorithm */
28enum crypto_dec_algo {
29 CRYPTO_GCM_DECRYPT = 0
30};
31
Manish V Badarkhee112a5a2021-10-06 23:41:50 +010032/* Message digest algorithm */
33enum crypto_md_algo {
34 CRYPTO_MD_SHA256,
35 CRYPTO_MD_SHA384,
36 CRYPTO_MD_SHA512,
37};
38
39/* Maximum size as per the known stronger hash algorithm i.e.SHA512 */
40#define CRYPTO_MD_MAX_SIZE 64U
41
Juan Castillo8e55d932015-04-02 09:48:16 +010042/*
43 * Cryptographic library descriptor
44 */
45typedef struct crypto_lib_desc_s {
46 const char *name;
47
48 /* Initialize library. This function is not expected to fail. All errors
49 * must be handled inside the function, asserting or panicing in case of
50 * a non-recoverable error */
51 void (*init)(void);
52
53 /* Verify a digital signature. Return one of the
54 * 'enum crypto_ret_value' options */
55 int (*verify_signature)(void *data_ptr, unsigned int data_len,
56 void *sig_ptr, unsigned int sig_len,
57 void *sig_alg, unsigned int sig_alg_len,
58 void *pk_ptr, unsigned int pk_len);
59
60 /* Verify a hash. Return one of the 'enum crypto_ret_value' options */
61 int (*verify_hash)(void *data_ptr, unsigned int data_len,
62 void *digest_info_ptr, unsigned int digest_info_len);
Alexei Fedorov913cb7e2020-01-23 14:27:38 +000063
Alexei Fedorov913cb7e2020-01-23 14:27:38 +000064 /* Calculate a hash. Return hash value */
Manish V Badarkhee112a5a2021-10-06 23:41:50 +010065 int (*calc_hash)(enum crypto_md_algo md_alg, void *data_ptr,
66 unsigned int data_len,
67 unsigned char output[CRYPTO_MD_MAX_SIZE]);
Alexei Fedorov913cb7e2020-01-23 14:27:38 +000068
Yann Gautierc68b8af2023-01-24 09:39:47 +010069 /* Convert Public key (optional) */
70 int (*convert_pk)(void *full_pk_ptr, unsigned int full_pk_len,
71 void **hashed_pk_ptr, unsigned int *hashed_pk_len);
72
Sumit Garg392e4df2019-11-15 10:43:00 +053073 /*
74 * Authenticated decryption. Return one of the
75 * 'enum crypto_ret_value' options.
76 */
77 int (*auth_decrypt)(enum crypto_dec_algo dec_algo, void *data_ptr,
78 size_t len, const void *key, unsigned int key_len,
79 unsigned int key_flags, const void *iv,
80 unsigned int iv_len, const void *tag,
81 unsigned int tag_len);
Juan Castillo8e55d932015-04-02 09:48:16 +010082} crypto_lib_desc_t;
83
84/* Public functions */
Manish V Badarkhe92de80a2021-12-16 10:41:47 +000085#if CRYPTO_SUPPORT
Juan Castillo8e55d932015-04-02 09:48:16 +010086void crypto_mod_init(void);
Manish V Badarkhe92de80a2021-12-16 10:41:47 +000087#else
88static inline void crypto_mod_init(void)
89{
90}
91#endif /* CRYPTO_SUPPORT */
92
Yann Gautier2b6673d2023-03-15 11:31:25 +010093#if (CRYPTO_SUPPORT == CRYPTO_AUTH_VERIFY_ONLY) || \
94 (CRYPTO_SUPPORT == CRYPTO_AUTH_VERIFY_AND_HASH_CALC)
Juan Castillo8e55d932015-04-02 09:48:16 +010095int crypto_mod_verify_signature(void *data_ptr, unsigned int data_len,
96 void *sig_ptr, unsigned int sig_len,
Roberto Vargasbe126ed2018-02-12 12:36:17 +000097 void *sig_alg_ptr, unsigned int sig_alg_len,
Juan Castillo8e55d932015-04-02 09:48:16 +010098 void *pk_ptr, unsigned int pk_len);
99int crypto_mod_verify_hash(void *data_ptr, unsigned int data_len,
100 void *digest_info_ptr, unsigned int digest_info_len);
Yann Gautier2b6673d2023-03-15 11:31:25 +0100101#endif /* (CRYPTO_SUPPORT == CRYPTO_AUTH_VERIFY_ONLY) || \
102 (CRYPTO_SUPPORT == CRYPTO_AUTH_VERIFY_AND_HASH_CALC) */
Manish V Badarkhec9fdaf62022-06-20 15:32:38 +0100103
Sumit Garg392e4df2019-11-15 10:43:00 +0530104int crypto_mod_auth_decrypt(enum crypto_dec_algo dec_algo, void *data_ptr,
105 size_t len, const void *key, unsigned int key_len,
106 unsigned int key_flags, const void *iv,
107 unsigned int iv_len, const void *tag,
108 unsigned int tag_len);
Juan Castillo8e55d932015-04-02 09:48:16 +0100109
Yann Gautier2b6673d2023-03-15 11:31:25 +0100110#if (CRYPTO_SUPPORT == CRYPTO_HASH_CALC_ONLY) || \
111 (CRYPTO_SUPPORT == CRYPTO_AUTH_VERIFY_AND_HASH_CALC)
Manish V Badarkhee112a5a2021-10-06 23:41:50 +0100112int crypto_mod_calc_hash(enum crypto_md_algo alg, void *data_ptr,
113 unsigned int data_len,
114 unsigned char output[CRYPTO_MD_MAX_SIZE]);
Yann Gautier2b6673d2023-03-15 11:31:25 +0100115#endif /* (CRYPTO_SUPPORT == CRYPTO_HASH_CALC_ONLY) || \
116 (CRYPTO_SUPPORT == CRYPTO_AUTH_VERIFY_AND_HASH_CALC) */
Alexei Fedorov913cb7e2020-01-23 14:27:38 +0000117
Yann Gautierc68b8af2023-01-24 09:39:47 +0100118int crypto_mod_convert_pk(void *full_pk_ptr, unsigned int full_pk_len,
119 void **hashed_pk_ptr, unsigned int *hashed_pk_len);
120
Juan Castillo8e55d932015-04-02 09:48:16 +0100121/* Macro to register a cryptographic library */
Alexei Fedorov913cb7e2020-01-23 14:27:38 +0000122#define REGISTER_CRYPTO_LIB(_name, _init, _verify_signature, _verify_hash, \
Yann Gautierc68b8af2023-01-24 09:39:47 +0100123 _calc_hash, _auth_decrypt, _convert_pk) \
Alexei Fedorov913cb7e2020-01-23 14:27:38 +0000124 const crypto_lib_desc_t crypto_lib_desc = { \
125 .name = _name, \
126 .init = _init, \
127 .verify_signature = _verify_signature, \
128 .verify_hash = _verify_hash, \
Sumit Garg392e4df2019-11-15 10:43:00 +0530129 .calc_hash = _calc_hash, \
Yann Gautierc68b8af2023-01-24 09:39:47 +0100130 .auth_decrypt = _auth_decrypt, \
131 .convert_pk = _convert_pk \
Alexei Fedorov913cb7e2020-01-23 14:27:38 +0000132 }
Juan Castillo8e55d932015-04-02 09:48:16 +0100133
Roberto Vargas52f707f2018-02-12 12:36:17 +0000134extern const crypto_lib_desc_t crypto_lib_desc;
135
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +0000136#endif /* CRYPTO_MOD_H */