blob: f60997f0fb9b13738eabb65f15e637dacd9d404e [file] [log] [blame]
Juan Castillo11abdcd2014-10-21 11:30:42 +01001/*
2 * Copyright (c) 2015, ARM Limited and Contributors. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * Redistributions of source code must retain the above copyright notice, this
8 * list of conditions and the following disclaimer.
9 *
10 * Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation
12 * and/or other materials provided with the distribution.
13 *
14 * Neither the name of ARM nor the names of its contributors may be used
15 * to endorse or promote products derived from this software without specific
16 * prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef KEY_H_
32#define KEY_H_
33
34#include <openssl/ossl_typ.h>
35
36#define RSA_KEY_BITS 2048
37
Juan Castillof9f39c32015-06-01 16:34:23 +010038/* Error codes */
39enum {
40 KEY_ERR_NONE,
41 KEY_ERR_MALLOC,
42 KEY_ERR_FILENAME,
43 KEY_ERR_OPEN,
44 KEY_ERR_LOAD
45};
46
47/* Supported key algorithms */
48enum {
49 KEY_ALG_RSA,
Juan Castilloa2224ab2015-06-30 13:36:57 +010050#ifndef OPENSSL_NO_EC
51 KEY_ALG_ECDSA,
52#endif /* OPENSSL_NO_EC */
53 KEY_ALG_MAX_NUM
Juan Castillof9f39c32015-06-01 16:34:23 +010054};
55
Juan Castillo11abdcd2014-10-21 11:30:42 +010056/*
57 * This structure contains the relevant information to create the keys
58 * required to sign the certificates.
59 *
60 * One instance of this structure must be created for each key, usually in an
61 * array fashion. The filename is obtained at run time from the command line
62 * parameters
63 */
64typedef struct key_s {
65 int id; /* Key id */
Juan Castillo1218dd52015-07-03 16:23:16 +010066 const char *opt; /* Command line option to specify a key */
Juan Castillo212f7382015-12-15 16:37:57 +000067 const char *help_msg; /* Help message */
Juan Castillo11abdcd2014-10-21 11:30:42 +010068 const char *desc; /* Key description (debug purposes) */
69 char *fn; /* Filename to load/store the key */
70 EVP_PKEY *key; /* Key container */
71} key_t;
72
Juan Castilloe6d30e92015-06-12 11:27:59 +010073/* Exported API */
Juan Castillo1218dd52015-07-03 16:23:16 +010074int key_init(void);
75key_t *key_get_by_opt(const char *opt);
Juan Castillof9f39c32015-06-01 16:34:23 +010076int key_create(key_t *key, int type);
77int key_load(key_t *key, unsigned int *err_code);
Juan Castillo11abdcd2014-10-21 11:30:42 +010078int key_store(key_t *key);
79
Juan Castilloe6d30e92015-06-12 11:27:59 +010080/* Macro to register the keys used in the CoT */
81#define REGISTER_KEYS(_keys) \
82 key_t *keys = &_keys[0]; \
Sandrine Bailleuxdf8de2d2016-01-04 15:49:23 +000083 const unsigned int num_keys = sizeof(_keys)/sizeof(_keys[0])
Juan Castilloe6d30e92015-06-12 11:27:59 +010084
85/* Exported variables */
86extern key_t *keys;
87extern const unsigned int num_keys;
88
Juan Castillo11abdcd2014-10-21 11:30:42 +010089#endif /* KEY_H_ */