1/*
2 * Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved.
3 *
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
8 */
9
10#include "internal/refcount.h"
11
12/* Internal X509 structures and functions: not for application use */
13
14/* Note: unless otherwise stated a field pointer is mandatory and should
15 * never be set to NULL: the ASN.1 code and accessors rely on mandatory
16 * fields never being NULL.
17 */
18
19/*
20 * name entry structure, equivalent to AttributeTypeAndValue defined
21 * in RFC5280 et al.
22 */
23struct X509_name_entry_st {
24 ASN1_OBJECT *object; /* AttributeType */
25 ASN1_STRING *value; /* AttributeValue */
26 int set; /* index of RDNSequence for this entry */
27 int size; /* temp variable */
28};
29
30/* Name from RFC 5280. */
31struct X509_name_st {
32 STACK_OF(X509_NAME_ENTRY) *entries; /* DN components */
33 int modified; /* true if 'bytes' needs to be built */
34 BUF_MEM *bytes; /* cached encoding: cannot be NULL */
35 /* canonical encoding used for rapid Name comparison */
36 unsigned char *canon_enc;
37 int canon_enclen;
38} /* X509_NAME */ ;
39
40/* Signature info structure */
41
42struct x509_sig_info_st {
43 /* NID of message digest */
44 int mdnid;
45 /* NID of public key algorithm */
46 int pknid;
47 /* Security bits */
48 int secbits;
49 /* Various flags */
50 uint32_t flags;
51};
52
53/* PKCS#10 certificate request */
54
55struct X509_req_info_st {
56 ASN1_ENCODING enc; /* cached encoding of signed part */
57 ASN1_INTEGER *version; /* version, defaults to v1(0) so can be NULL */
58 X509_NAME *subject; /* certificate request DN */
59 X509_PUBKEY *pubkey; /* public key of request */
60 /*
61 * Zero or more attributes.
62 * NB: although attributes is a mandatory field some broken
63 * encodings omit it so this may be NULL in that case.
64 */
65 STACK_OF(X509_ATTRIBUTE) *attributes;
66};
67
68struct X509_req_st {
69 X509_REQ_INFO req_info; /* signed certificate request data */
70 X509_ALGOR sig_alg; /* signature algorithm */
71 ASN1_BIT_STRING *signature; /* signature */
72 CRYPTO_REF_COUNT references;
73 CRYPTO_RWLOCK *lock;
74# ifndef OPENSSL_NO_SM2
75 ASN1_OCTET_STRING *sm2_id;
76# endif
77};
78
79struct X509_crl_info_st {
80 ASN1_INTEGER *version; /* version: defaults to v1(0) so may be NULL */
81 X509_ALGOR sig_alg; /* signature algorithm */
82 X509_NAME *issuer; /* CRL issuer name */
83 ASN1_TIME *lastUpdate; /* lastUpdate field */
84 ASN1_TIME *nextUpdate; /* nextUpdate field: optional */
85 STACK_OF(X509_REVOKED) *revoked; /* revoked entries: optional */
86 STACK_OF(X509_EXTENSION) *extensions; /* extensions: optional */
87 ASN1_ENCODING enc; /* encoding of signed portion of CRL */
88};
89
90struct X509_crl_st {
91 X509_CRL_INFO crl; /* signed CRL data */
92 X509_ALGOR sig_alg; /* CRL signature algorithm */
93 ASN1_BIT_STRING signature; /* CRL signature */
94 CRYPTO_REF_COUNT references;
95 int flags;
96 /*
97 * Cached copies of decoded extension values, since extensions
98 * are optional any of these can be NULL.
99 */
100 AUTHORITY_KEYID *akid;
101 ISSUING_DIST_POINT *idp;
102 /* Convenient breakdown of IDP */
103 int idp_flags;
104 int idp_reasons;
105 /* CRL and base CRL numbers for delta processing */
106 ASN1_INTEGER *crl_number;
107 ASN1_INTEGER *base_crl_number;
108 STACK_OF(GENERAL_NAMES) *issuers;
109 /* hash of CRL */
110 unsigned char sha1_hash[SHA_DIGEST_LENGTH];
111 /* alternative method to handle this CRL */
112 const X509_CRL_METHOD *meth;
113 void *meth_data;
114 CRYPTO_RWLOCK *lock;
115};
116
117struct x509_revoked_st {
118 ASN1_INTEGER serialNumber; /* revoked entry serial number */
119 ASN1_TIME *revocationDate; /* revocation date */
120 STACK_OF(X509_EXTENSION) *extensions; /* CRL entry extensions: optional */
121 /* decoded value of CRLissuer extension: set if indirect CRL */
122 STACK_OF(GENERAL_NAME) *issuer;
123 /* revocation reason: set to CRL_REASON_NONE if reason extension absent */
124 int reason;
125 /*
126 * CRL entries are reordered for faster lookup of serial numbers. This
127 * field contains the original load sequence for this entry.
128 */
129 int sequence;
130};
131
132/*
133 * This stuff is certificate "auxiliary info": it contains details which are
134 * useful in certificate stores and databases. When used this is tagged onto
135 * the end of the certificate itself. OpenSSL specific structure not defined
136 * in any RFC.
137 */
138
139struct x509_cert_aux_st {
140 STACK_OF(ASN1_OBJECT) *trust; /* trusted uses */
141 STACK_OF(ASN1_OBJECT) *reject; /* rejected uses */
142 ASN1_UTF8STRING *alias; /* "friendly name" */
143 ASN1_OCTET_STRING *keyid; /* key id of private key */
144 STACK_OF(X509_ALGOR) *other; /* other unspecified info */
145};
146
147struct x509_cinf_st {
148 ASN1_INTEGER *version; /* [ 0 ] default of v1 */
149 ASN1_INTEGER serialNumber;
150 X509_ALGOR signature;
151 X509_NAME *issuer;
152 X509_VAL validity;
153 X509_NAME *subject;
154 X509_PUBKEY *key;
155 ASN1_BIT_STRING *issuerUID; /* [ 1 ] optional in v2 */
156 ASN1_BIT_STRING *subjectUID; /* [ 2 ] optional in v2 */
157 STACK_OF(X509_EXTENSION) *extensions; /* [ 3 ] optional in v3 */
158 ASN1_ENCODING enc;
159};
160
161struct x509_st {
162 X509_CINF cert_info;
163 X509_ALGOR sig_alg;
164 ASN1_BIT_STRING signature;
165 X509_SIG_INFO siginf;
166 CRYPTO_REF_COUNT references;
167 CRYPTO_EX_DATA ex_data;
168 /* These contain copies of various extension values */
169 long ex_pathlen;
170 long ex_pcpathlen;
171 uint32_t ex_flags;
172 uint32_t ex_kusage;
173 uint32_t ex_xkusage;
174 uint32_t ex_nscert;
175 ASN1_OCTET_STRING *skid;
176 AUTHORITY_KEYID *akid;
177 X509_POLICY_CACHE *policy_cache;
178 STACK_OF(DIST_POINT) *crldp;
179 STACK_OF(GENERAL_NAME) *altname;
180 NAME_CONSTRAINTS *nc;
181# ifndef OPENSSL_NO_RFC3779
182 STACK_OF(IPAddressFamily) *rfc3779_addr;
183 struct ASIdentifiers_st *rfc3779_asid;
184# endif
185 unsigned char sha1_hash[SHA_DIGEST_LENGTH];
186 X509_CERT_AUX *aux;
187 CRYPTO_RWLOCK *lock;
188 volatile int ex_cached;
189# ifndef OPENSSL_NO_SM2
190 ASN1_OCTET_STRING *sm2_id;
191# endif
192} /* X509 */ ;
193
194/*
195 * This is a used when verifying cert chains. Since the gathering of the
196 * cert chain can take some time (and have to be 'retried', this needs to be
197 * kept and passed around.
198 */
199struct x509_store_ctx_st { /* X509_STORE_CTX */
200 X509_STORE *store;
201 /* The following are set by the caller */
202 /* The cert to check */
203 X509 *cert;
204 /* chain of X509s - untrusted - passed in */
205 STACK_OF(X509) *untrusted;
206 /* set of CRLs passed in */
207 STACK_OF(X509_CRL) *crls;
208 X509_VERIFY_PARAM *param;
209 /* Other info for use with get_issuer() */
210 void *other_ctx;
211 /* Callbacks for various operations */
212 /* called to verify a certificate */
213 int (*verify) (X509_STORE_CTX *ctx);
214 /* error callback */
215 int (*verify_cb) (int ok, X509_STORE_CTX *ctx);
216 /* get issuers cert from ctx */
217 int (*get_issuer) (X509 **issuer, X509_STORE_CTX *ctx, X509 *x);
218 /* check issued */
219 int (*check_issued) (X509_STORE_CTX *ctx, X509 *x, X509 *issuer);
220 /* Check revocation status of chain */
221 int (*check_revocation) (X509_STORE_CTX *ctx);
222 /* retrieve CRL */
223 int (*get_crl) (X509_STORE_CTX *ctx, X509_CRL **crl, X509 *x);
224 /* Check CRL validity */
225 int (*check_crl) (X509_STORE_CTX *ctx, X509_CRL *crl);
226 /* Check certificate against CRL */
227 int (*cert_crl) (X509_STORE_CTX *ctx, X509_CRL *crl, X509 *x);
228 /* Check policy status of the chain */
229 int (*check_policy) (X509_STORE_CTX *ctx);
230 STACK_OF(X509) *(*lookup_certs) (X509_STORE_CTX *ctx, X509_NAME *nm);
231 STACK_OF(X509_CRL) *(*lookup_crls) (X509_STORE_CTX *ctx, X509_NAME *nm);
232 int (*cleanup) (X509_STORE_CTX *ctx);
233 /* The following is built up */
234 /* if 0, rebuild chain */
235 int valid;
236 /* number of untrusted certs */
237 int num_untrusted;
238 /* chain of X509s - built up and trusted */
239 STACK_OF(X509) *chain;
240 /* Valid policy tree */
241 X509_POLICY_TREE *tree;
242 /* Require explicit policy value */
243 int explicit_policy;
244 /* When something goes wrong, this is why */
245 int error_depth;
246 int error;
247 X509 *current_cert;
248 /* cert currently being tested as valid issuer */
249 X509 *current_issuer;
250 /* current CRL */
251 X509_CRL *current_crl;
252 /* score of current CRL */
253 int current_crl_score;
254 /* Reason mask */
255 unsigned int current_reasons;
256 /* For CRL path validation: parent context */
257 X509_STORE_CTX *parent;
258 CRYPTO_EX_DATA ex_data;
259 SSL_DANE *dane;
260 /* signed via bare TA public key, rather than CA certificate */
261 int bare_ta_signed;
262};
263
264/* PKCS#8 private key info structure */
265
266struct pkcs8_priv_key_info_st {
267 ASN1_INTEGER *version;
268 X509_ALGOR *pkeyalg;
269 ASN1_OCTET_STRING *pkey;
270 STACK_OF(X509_ATTRIBUTE) *attributes;
271};
272
273struct X509_sig_st {
274 X509_ALGOR *algor;
275 ASN1_OCTET_STRING *digest;
276};
277
278struct x509_object_st {
279 /* one of the above types */
280 X509_LOOKUP_TYPE type;
281 union {
282 char *ptr;
283 X509 *x509;
284 X509_CRL *crl;
285 EVP_PKEY *pkey;
286 } data;
287};
288
289int a2i_ipadd(unsigned char *ipout, const char *ipasc);
290int x509_set1_time(ASN1_TIME **ptm, const ASN1_TIME *tm);
291
292void x509_init_sig_info(X509 *x);
293