xref: /aosp_15_r20/external/wpa_supplicant_8/src/tls/x509v3.h (revision 03f9172ca588f91df233974f4258bab95191f931)
1*03f9172cSAndroid Build Coastguard Worker /*
2*03f9172cSAndroid Build Coastguard Worker  * X.509v3 certificate parsing and processing
3*03f9172cSAndroid Build Coastguard Worker  * Copyright (c) 2006-2011, Jouni Malinen <[email protected]>
4*03f9172cSAndroid Build Coastguard Worker  *
5*03f9172cSAndroid Build Coastguard Worker  * This software may be distributed under the terms of the BSD license.
6*03f9172cSAndroid Build Coastguard Worker  * See README for more details.
7*03f9172cSAndroid Build Coastguard Worker  */
8*03f9172cSAndroid Build Coastguard Worker 
9*03f9172cSAndroid Build Coastguard Worker #ifndef X509V3_H
10*03f9172cSAndroid Build Coastguard Worker #define X509V3_H
11*03f9172cSAndroid Build Coastguard Worker 
12*03f9172cSAndroid Build Coastguard Worker #include "asn1.h"
13*03f9172cSAndroid Build Coastguard Worker 
14*03f9172cSAndroid Build Coastguard Worker struct x509_algorithm_identifier {
15*03f9172cSAndroid Build Coastguard Worker 	struct asn1_oid oid;
16*03f9172cSAndroid Build Coastguard Worker };
17*03f9172cSAndroid Build Coastguard Worker 
18*03f9172cSAndroid Build Coastguard Worker struct x509_name_attr {
19*03f9172cSAndroid Build Coastguard Worker 	enum x509_name_attr_type {
20*03f9172cSAndroid Build Coastguard Worker 		X509_NAME_ATTR_NOT_USED,
21*03f9172cSAndroid Build Coastguard Worker 		X509_NAME_ATTR_DC,
22*03f9172cSAndroid Build Coastguard Worker 		X509_NAME_ATTR_CN,
23*03f9172cSAndroid Build Coastguard Worker 		X509_NAME_ATTR_C,
24*03f9172cSAndroid Build Coastguard Worker 		X509_NAME_ATTR_L,
25*03f9172cSAndroid Build Coastguard Worker 		X509_NAME_ATTR_ST,
26*03f9172cSAndroid Build Coastguard Worker 		X509_NAME_ATTR_O,
27*03f9172cSAndroid Build Coastguard Worker 		X509_NAME_ATTR_OU
28*03f9172cSAndroid Build Coastguard Worker 	} type;
29*03f9172cSAndroid Build Coastguard Worker 	char *value;
30*03f9172cSAndroid Build Coastguard Worker };
31*03f9172cSAndroid Build Coastguard Worker 
32*03f9172cSAndroid Build Coastguard Worker #define X509_MAX_NAME_ATTRIBUTES 20
33*03f9172cSAndroid Build Coastguard Worker 
34*03f9172cSAndroid Build Coastguard Worker struct x509_name {
35*03f9172cSAndroid Build Coastguard Worker 	struct x509_name_attr attr[X509_MAX_NAME_ATTRIBUTES];
36*03f9172cSAndroid Build Coastguard Worker 	size_t num_attr;
37*03f9172cSAndroid Build Coastguard Worker 	char *email; /* emailAddress */
38*03f9172cSAndroid Build Coastguard Worker 
39*03f9172cSAndroid Build Coastguard Worker 	/* from alternative name extension */
40*03f9172cSAndroid Build Coastguard Worker 	char *alt_email; /* rfc822Name */
41*03f9172cSAndroid Build Coastguard Worker 	char *dns; /* dNSName */
42*03f9172cSAndroid Build Coastguard Worker 	char *uri; /* uniformResourceIdentifier */
43*03f9172cSAndroid Build Coastguard Worker 	u8 *ip; /* iPAddress */
44*03f9172cSAndroid Build Coastguard Worker 	size_t ip_len; /* IPv4: 4, IPv6: 16 */
45*03f9172cSAndroid Build Coastguard Worker 	struct asn1_oid rid; /* registeredID */
46*03f9172cSAndroid Build Coastguard Worker };
47*03f9172cSAndroid Build Coastguard Worker 
48*03f9172cSAndroid Build Coastguard Worker #define X509_MAX_SERIAL_NUM_LEN 20
49*03f9172cSAndroid Build Coastguard Worker 
50*03f9172cSAndroid Build Coastguard Worker struct x509_certificate {
51*03f9172cSAndroid Build Coastguard Worker 	struct x509_certificate *next;
52*03f9172cSAndroid Build Coastguard Worker 	enum { X509_CERT_V1 = 0, X509_CERT_V2 = 1, X509_CERT_V3 = 2 } version;
53*03f9172cSAndroid Build Coastguard Worker 	u8 serial_number[X509_MAX_SERIAL_NUM_LEN];
54*03f9172cSAndroid Build Coastguard Worker 	size_t serial_number_len;
55*03f9172cSAndroid Build Coastguard Worker 	struct x509_algorithm_identifier signature;
56*03f9172cSAndroid Build Coastguard Worker 	struct x509_name issuer;
57*03f9172cSAndroid Build Coastguard Worker 	struct x509_name subject;
58*03f9172cSAndroid Build Coastguard Worker 	u8 *subject_dn;
59*03f9172cSAndroid Build Coastguard Worker 	size_t subject_dn_len;
60*03f9172cSAndroid Build Coastguard Worker 	os_time_t not_before;
61*03f9172cSAndroid Build Coastguard Worker 	os_time_t not_after;
62*03f9172cSAndroid Build Coastguard Worker 	struct x509_algorithm_identifier public_key_alg;
63*03f9172cSAndroid Build Coastguard Worker 	u8 *public_key;
64*03f9172cSAndroid Build Coastguard Worker 	size_t public_key_len;
65*03f9172cSAndroid Build Coastguard Worker 	struct x509_algorithm_identifier signature_alg;
66*03f9172cSAndroid Build Coastguard Worker 	u8 *sign_value;
67*03f9172cSAndroid Build Coastguard Worker 	size_t sign_value_len;
68*03f9172cSAndroid Build Coastguard Worker 
69*03f9172cSAndroid Build Coastguard Worker 	/* Extensions */
70*03f9172cSAndroid Build Coastguard Worker 	unsigned int extensions_present;
71*03f9172cSAndroid Build Coastguard Worker #define X509_EXT_BASIC_CONSTRAINTS		(1 << 0)
72*03f9172cSAndroid Build Coastguard Worker #define X509_EXT_PATH_LEN_CONSTRAINT		(1 << 1)
73*03f9172cSAndroid Build Coastguard Worker #define X509_EXT_KEY_USAGE			(1 << 2)
74*03f9172cSAndroid Build Coastguard Worker #define X509_EXT_SUBJECT_ALT_NAME		(1 << 3)
75*03f9172cSAndroid Build Coastguard Worker #define X509_EXT_ISSUER_ALT_NAME		(1 << 4)
76*03f9172cSAndroid Build Coastguard Worker #define X509_EXT_EXT_KEY_USAGE			(1 << 5)
77*03f9172cSAndroid Build Coastguard Worker #define X509_EXT_CERTIFICATE_POLICY		(1 << 6)
78*03f9172cSAndroid Build Coastguard Worker 
79*03f9172cSAndroid Build Coastguard Worker 	/* BasicConstraints */
80*03f9172cSAndroid Build Coastguard Worker 	int ca; /* cA */
81*03f9172cSAndroid Build Coastguard Worker 	unsigned long path_len_constraint; /* pathLenConstraint */
82*03f9172cSAndroid Build Coastguard Worker 
83*03f9172cSAndroid Build Coastguard Worker 	/* KeyUsage */
84*03f9172cSAndroid Build Coastguard Worker 	unsigned long key_usage;
85*03f9172cSAndroid Build Coastguard Worker #define X509_KEY_USAGE_DIGITAL_SIGNATURE	(1 << 0)
86*03f9172cSAndroid Build Coastguard Worker #define X509_KEY_USAGE_NON_REPUDIATION		(1 << 1)
87*03f9172cSAndroid Build Coastguard Worker #define X509_KEY_USAGE_KEY_ENCIPHERMENT		(1 << 2)
88*03f9172cSAndroid Build Coastguard Worker #define X509_KEY_USAGE_DATA_ENCIPHERMENT	(1 << 3)
89*03f9172cSAndroid Build Coastguard Worker #define X509_KEY_USAGE_KEY_AGREEMENT		(1 << 4)
90*03f9172cSAndroid Build Coastguard Worker #define X509_KEY_USAGE_KEY_CERT_SIGN		(1 << 5)
91*03f9172cSAndroid Build Coastguard Worker #define X509_KEY_USAGE_CRL_SIGN			(1 << 6)
92*03f9172cSAndroid Build Coastguard Worker #define X509_KEY_USAGE_ENCIPHER_ONLY		(1 << 7)
93*03f9172cSAndroid Build Coastguard Worker #define X509_KEY_USAGE_DECIPHER_ONLY		(1 << 8)
94*03f9172cSAndroid Build Coastguard Worker 
95*03f9172cSAndroid Build Coastguard Worker 	/* ExtKeyUsage */
96*03f9172cSAndroid Build Coastguard Worker 	unsigned long ext_key_usage;
97*03f9172cSAndroid Build Coastguard Worker #define X509_EXT_KEY_USAGE_ANY			(1 << 0)
98*03f9172cSAndroid Build Coastguard Worker #define X509_EXT_KEY_USAGE_SERVER_AUTH		(1 << 1)
99*03f9172cSAndroid Build Coastguard Worker #define X509_EXT_KEY_USAGE_CLIENT_AUTH		(1 << 2)
100*03f9172cSAndroid Build Coastguard Worker #define X509_EXT_KEY_USAGE_OCSP			(1 << 3)
101*03f9172cSAndroid Build Coastguard Worker 
102*03f9172cSAndroid Build Coastguard Worker 	/* CertificatePolicy */
103*03f9172cSAndroid Build Coastguard Worker 	unsigned long certificate_policy;
104*03f9172cSAndroid Build Coastguard Worker #define X509_EXT_CERT_POLICY_ANY		(1 << 0)
105*03f9172cSAndroid Build Coastguard Worker #define X509_EXT_CERT_POLICY_TOD_STRICT		(1 << 1)
106*03f9172cSAndroid Build Coastguard Worker #define X509_EXT_CERT_POLICY_TOD_TOFU		(1 << 2)
107*03f9172cSAndroid Build Coastguard Worker 
108*03f9172cSAndroid Build Coastguard Worker 	/*
109*03f9172cSAndroid Build Coastguard Worker 	 * The DER format certificate follows struct x509_certificate. These
110*03f9172cSAndroid Build Coastguard Worker 	 * pointers point to that buffer.
111*03f9172cSAndroid Build Coastguard Worker 	 */
112*03f9172cSAndroid Build Coastguard Worker 	const u8 *cert_start;
113*03f9172cSAndroid Build Coastguard Worker 	size_t cert_len;
114*03f9172cSAndroid Build Coastguard Worker 	const u8 *tbs_cert_start;
115*03f9172cSAndroid Build Coastguard Worker 	size_t tbs_cert_len;
116*03f9172cSAndroid Build Coastguard Worker 
117*03f9172cSAndroid Build Coastguard Worker 	/* Meta data used for certificate validation */
118*03f9172cSAndroid Build Coastguard Worker 	unsigned int ocsp_good:1;
119*03f9172cSAndroid Build Coastguard Worker 	unsigned int ocsp_revoked:1;
120*03f9172cSAndroid Build Coastguard Worker 	unsigned int issuer_trusted:1;
121*03f9172cSAndroid Build Coastguard Worker };
122*03f9172cSAndroid Build Coastguard Worker 
123*03f9172cSAndroid Build Coastguard Worker enum {
124*03f9172cSAndroid Build Coastguard Worker 	X509_VALIDATE_OK,
125*03f9172cSAndroid Build Coastguard Worker 	X509_VALIDATE_BAD_CERTIFICATE,
126*03f9172cSAndroid Build Coastguard Worker 	X509_VALIDATE_UNSUPPORTED_CERTIFICATE,
127*03f9172cSAndroid Build Coastguard Worker 	X509_VALIDATE_CERTIFICATE_REVOKED,
128*03f9172cSAndroid Build Coastguard Worker 	X509_VALIDATE_CERTIFICATE_EXPIRED,
129*03f9172cSAndroid Build Coastguard Worker 	X509_VALIDATE_CERTIFICATE_UNKNOWN,
130*03f9172cSAndroid Build Coastguard Worker 	X509_VALIDATE_UNKNOWN_CA
131*03f9172cSAndroid Build Coastguard Worker };
132*03f9172cSAndroid Build Coastguard Worker 
133*03f9172cSAndroid Build Coastguard Worker void x509_certificate_free(struct x509_certificate *cert);
134*03f9172cSAndroid Build Coastguard Worker int x509_parse_algorithm_identifier(const u8 *buf, size_t len,
135*03f9172cSAndroid Build Coastguard Worker 				    struct x509_algorithm_identifier *id,
136*03f9172cSAndroid Build Coastguard Worker 				    const u8 **next);
137*03f9172cSAndroid Build Coastguard Worker int x509_parse_name(const u8 *buf, size_t len, struct x509_name *name,
138*03f9172cSAndroid Build Coastguard Worker 		    const u8 **next);
139*03f9172cSAndroid Build Coastguard Worker int x509_parse_time(const u8 *buf, size_t len, u8 asn1_tag, os_time_t *val);
140*03f9172cSAndroid Build Coastguard Worker struct x509_certificate * x509_certificate_parse(const u8 *buf, size_t len);
141*03f9172cSAndroid Build Coastguard Worker void x509_free_name(struct x509_name *name);
142*03f9172cSAndroid Build Coastguard Worker void x509_name_string(struct x509_name *name, char *buf, size_t len);
143*03f9172cSAndroid Build Coastguard Worker int x509_name_compare(struct x509_name *a, struct x509_name *b);
144*03f9172cSAndroid Build Coastguard Worker void x509_certificate_chain_free(struct x509_certificate *cert);
145*03f9172cSAndroid Build Coastguard Worker int x509_check_signature(struct x509_certificate *issuer,
146*03f9172cSAndroid Build Coastguard Worker 			 struct x509_algorithm_identifier *signature,
147*03f9172cSAndroid Build Coastguard Worker 			 const u8 *sign_value, size_t sign_value_len,
148*03f9172cSAndroid Build Coastguard Worker 			 const u8 *signed_data, size_t signed_data_len);
149*03f9172cSAndroid Build Coastguard Worker int x509_certificate_check_signature(struct x509_certificate *issuer,
150*03f9172cSAndroid Build Coastguard Worker 				     struct x509_certificate *cert);
151*03f9172cSAndroid Build Coastguard Worker int x509_certificate_chain_validate(struct x509_certificate *trusted,
152*03f9172cSAndroid Build Coastguard Worker 				    struct x509_certificate *chain,
153*03f9172cSAndroid Build Coastguard Worker 				    int *reason, int disable_time_checks);
154*03f9172cSAndroid Build Coastguard Worker struct x509_certificate *
155*03f9172cSAndroid Build Coastguard Worker x509_certificate_get_subject(struct x509_certificate *chain,
156*03f9172cSAndroid Build Coastguard Worker 			     struct x509_name *name);
157*03f9172cSAndroid Build Coastguard Worker int x509_certificate_self_signed(struct x509_certificate *cert);
158*03f9172cSAndroid Build Coastguard Worker 
159*03f9172cSAndroid Build Coastguard Worker int x509_sha1_oid(struct asn1_oid *oid);
160*03f9172cSAndroid Build Coastguard Worker int x509_sha256_oid(struct asn1_oid *oid);
161*03f9172cSAndroid Build Coastguard Worker int x509_sha384_oid(struct asn1_oid *oid);
162*03f9172cSAndroid Build Coastguard Worker int x509_sha512_oid(struct asn1_oid *oid);
163*03f9172cSAndroid Build Coastguard Worker 
164*03f9172cSAndroid Build Coastguard Worker #endif /* X509V3_H */
165