16f971622SJuan Castillo /* 2*cf2dd17dSJuan Pablo Conde * Copyright (c) 2015-2022, Arm Limited and Contributors. All rights reserved. 36f971622SJuan Castillo * 482cb2c1aSdp-arm * SPDX-License-Identifier: BSD-3-Clause 56f971622SJuan Castillo */ 66f971622SJuan Castillo 7c3cf06f1SAntonio Nino Diaz #ifndef KEY_H 8c3cf06f1SAntonio Nino Diaz #define KEY_H 96f971622SJuan Castillo 106f971622SJuan Castillo #include <openssl/ossl_typ.h> 116f971622SJuan Castillo 12ccbf890eSJuan Castillo /* Error codes */ 13ccbf890eSJuan Castillo enum { 14ccbf890eSJuan Castillo KEY_ERR_NONE, 15ccbf890eSJuan Castillo KEY_ERR_MALLOC, 16ccbf890eSJuan Castillo KEY_ERR_FILENAME, 17ccbf890eSJuan Castillo KEY_ERR_OPEN, 18ccbf890eSJuan Castillo KEY_ERR_LOAD 19ccbf890eSJuan Castillo }; 20ccbf890eSJuan Castillo 21ccbf890eSJuan Castillo /* Supported key algorithms */ 22ccbf890eSJuan Castillo enum { 23a8eb286aSSoby Mathew KEY_ALG_RSA, /* RSA PSS as defined by PKCS#1 v2.1 (default) */ 24ed2a76eaSJuan Castillo #ifndef OPENSSL_NO_EC 25ed2a76eaSJuan Castillo KEY_ALG_ECDSA, 26ed2a76eaSJuan Castillo #endif /* OPENSSL_NO_EC */ 27ed2a76eaSJuan Castillo KEY_ALG_MAX_NUM 28ccbf890eSJuan Castillo }; 29ccbf890eSJuan Castillo 30dfe0f4c2SJustin Chadwell /* Maximum number of valid key sizes per algorithm */ 31dfe0f4c2SJustin Chadwell #define KEY_SIZE_MAX_NUM 4 32dfe0f4c2SJustin Chadwell 332972247cSQixiang Xu /* Supported hash algorithms */ 342972247cSQixiang Xu enum{ 352972247cSQixiang Xu HASH_ALG_SHA256, 362972247cSQixiang Xu HASH_ALG_SHA384, 372972247cSQixiang Xu HASH_ALG_SHA512, 382972247cSQixiang Xu }; 392972247cSQixiang Xu 40dfe0f4c2SJustin Chadwell /* Supported key sizes */ 41dfe0f4c2SJustin Chadwell /* NOTE: the first item in each array is the default key size */ 42dfe0f4c2SJustin Chadwell static const unsigned int KEY_SIZES[KEY_ALG_MAX_NUM][KEY_SIZE_MAX_NUM] = { 43dfe0f4c2SJustin Chadwell { 2048, 1024, 3072, 4096 }, /* KEY_ALG_RSA */ 44dfe0f4c2SJustin Chadwell #ifndef OPENSSL_NO_EC 45dfe0f4c2SJustin Chadwell {} /* KEY_ALG_ECDSA */ 46dfe0f4c2SJustin Chadwell #endif /* OPENSSL_NO_EC */ 47dfe0f4c2SJustin Chadwell }; 48dfe0f4c2SJustin Chadwell 496f971622SJuan Castillo /* 506f971622SJuan Castillo * This structure contains the relevant information to create the keys 516f971622SJuan Castillo * required to sign the certificates. 526f971622SJuan Castillo * 536f971622SJuan Castillo * One instance of this structure must be created for each key, usually in an 546f971622SJuan Castillo * array fashion. The filename is obtained at run time from the command line 556f971622SJuan Castillo * parameters 566f971622SJuan Castillo */ 576f971622SJuan Castillo typedef struct key_s { 586f971622SJuan Castillo int id; /* Key id */ 59ad2c1a9aSJuan Castillo const char *opt; /* Command line option to specify a key */ 60159807e2SJuan Castillo const char *help_msg; /* Help message */ 616f971622SJuan Castillo const char *desc; /* Key description (debug purposes) */ 626f971622SJuan Castillo char *fn; /* Filename to load/store the key */ 636f971622SJuan Castillo EVP_PKEY *key; /* Key container */ 646f971622SJuan Castillo } key_t; 656f971622SJuan Castillo 6655e291a4SJuan Castillo /* Exported API */ 67ad2c1a9aSJuan Castillo int key_init(void); 68ad2c1a9aSJuan Castillo key_t *key_get_by_opt(const char *opt); 69*cf2dd17dSJuan Pablo Conde #if !USING_OPENSSL3 70762f1ebeSMasahiro Yamada int key_new(key_t *key); 71*cf2dd17dSJuan Pablo Conde #endif 72dfe0f4c2SJustin Chadwell int key_create(key_t *key, int type, int key_bits); 73ccbf890eSJuan Castillo int key_load(key_t *key, unsigned int *err_code); 746f971622SJuan Castillo int key_store(key_t *key); 75*cf2dd17dSJuan Pablo Conde void key_cleanup(void); 766f971622SJuan Castillo 7755e291a4SJuan Castillo /* Macro to register the keys used in the CoT */ 7855e291a4SJuan Castillo #define REGISTER_KEYS(_keys) \ 79b94bf967SPankaj Gupta key_t *def_keys = &_keys[0]; \ 80b94bf967SPankaj Gupta const unsigned int num_def_keys = sizeof(_keys)/sizeof(_keys[0]) 81b94bf967SPankaj Gupta 82b94bf967SPankaj Gupta /* Macro to register the platform defined keys used in the CoT */ 83b94bf967SPankaj Gupta #define PLAT_REGISTER_KEYS(_pdef_keys) \ 84b94bf967SPankaj Gupta key_t *pdef_keys = &_pdef_keys[0]; \ 85b94bf967SPankaj Gupta const unsigned int num_pdef_keys = sizeof(_pdef_keys)/sizeof(_pdef_keys[0]) 8655e291a4SJuan Castillo 8755e291a4SJuan Castillo /* Exported variables */ 88b94bf967SPankaj Gupta extern key_t *def_keys; 89b94bf967SPankaj Gupta extern const unsigned int num_def_keys; 90b94bf967SPankaj Gupta extern key_t *pdef_keys; 91b94bf967SPankaj Gupta extern const unsigned int num_pdef_keys; 9255e291a4SJuan Castillo 93b94bf967SPankaj Gupta extern key_t *keys; 94b94bf967SPankaj Gupta extern unsigned int num_keys; 95c3cf06f1SAntonio Nino Diaz #endif /* KEY_H */ 96