xref: /rk3399_ARM-atf/tools/cert_create/include/ext.h (revision 51faada71a219a8b94cd8d8e423f0f22e9da4d8f)
1 /*
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 EXT_H_
32 #define EXT_H_
33 
34 #include "key.h"
35 #include <openssl/x509v3.h>
36 
37 /* Extension types supported */
38 enum ext_type_e {
39 	EXT_TYPE_NVCOUNTER,
40 	EXT_TYPE_PKEY,
41 	EXT_TYPE_HASH
42 };
43 
44 /* NV-Counter types */
45 enum nvctr_type_e {
46 	NVCTR_TYPE_TFW,
47 	NVCTR_TYPE_NTFW
48 };
49 
50 /*
51  * This structure contains the relevant information to create the extensions
52  * to be included in the certificates. This extensions will be used to
53  * establish the chain of trust.
54  */
55 typedef struct ext_s {
56 	const char *oid;	/* OID of the extension */
57 	const char *sn;		/* Short name */
58 	const char *ln;		/* Long description */
59 	const char *opt;	/* Command line option to specify data */
60 	const char *help_msg;	/* Help message */
61 	const char *arg;	/* Argument passed from command line */
62 	int asn1_type;		/* OpenSSL ASN1 type of the extension data.
63 				 * Supported types are:
64 				 *   - V_ASN1_INTEGER
65 				 *   - V_ASN1_OCTET_STRING
66 				 */
67 	int type;		/* See ext_type_e */
68 
69 	/* Extension attributes (depends on extension type) */
70 	union {
71 		int nvctr_type;	/* See nvctr_type_e */
72 		int key;	/* Index into array of registered public keys */
73 	} attr;
74 
75 	int alias;		/* In case OpenSSL provides an standard
76 				 * extension of the same type, add the new
77 				 * extension as an alias of this one
78 				 */
79 
80 	X509V3_EXT_METHOD method; /* This field may be used to define a custom
81 				   * function to print the contents of the
82 				   * extension */
83 
84 	int optional;	/* This field may be used optionally to exclude an image */
85 } ext_t;
86 
87 enum {
88 	EXT_NON_CRIT = 0,
89 	EXT_CRIT = !EXT_NON_CRIT,
90 };
91 
92 /* Exported API */
93 int ext_init(void);
94 ext_t *ext_get_by_opt(const char *opt);
95 X509_EXTENSION *ext_new_hash(int nid, int crit, const EVP_MD *md,
96 		unsigned char *buf, size_t len);
97 X509_EXTENSION *ext_new_nvcounter(int nid, int crit, int value);
98 X509_EXTENSION *ext_new_key(int nid, int crit, EVP_PKEY *k);
99 
100 /* Macro to register the extensions used in the CoT */
101 #define REGISTER_EXTENSIONS(_ext) \
102 	ext_t *extensions = &_ext[0]; \
103 	const unsigned int num_extensions = sizeof(_ext)/sizeof(_ext[0])
104 
105 /* Exported variables */
106 extern ext_t *extensions;
107 extern const unsigned int num_extensions;
108 
109 #endif /* EXT_H_ */
110