include/openssl/macros.h: Rework OPENSSL_FUNC for div C standards
[openssl.git] / apps / verify.c
1 /*
2  * Copyright 1995-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 <stdio.h>
11 #include <stdlib.h>
12 #include <string.h>
13 #include "apps.h"
14 #include "progs.h"
15 #include <openssl/bio.h>
16 #include <openssl/err.h>
17 #include <openssl/x509.h>
18 #include <openssl/x509v3.h>
19 #include <openssl/pem.h>
20
21 static int cb(int ok, X509_STORE_CTX *ctx);
22 static int check(X509_STORE *ctx, const char *file,
23                  STACK_OF(X509) *uchain, STACK_OF(X509) *tchain,
24                  STACK_OF(X509_CRL) *crls, int show_chain,
25                  unsigned char *sm2id, size_t sm2idlen);
26 static int v_verbose = 0, vflags = 0;
27
28 typedef enum OPTION_choice {
29     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
30     OPT_ENGINE, OPT_CAPATH, OPT_CAFILE, OPT_NOCAPATH, OPT_NOCAFILE,
31     OPT_UNTRUSTED, OPT_TRUSTED, OPT_CRLFILE, OPT_CRL_DOWNLOAD, OPT_SHOW_CHAIN,
32     OPT_V_ENUM, OPT_NAMEOPT,
33     OPT_VERBOSE, OPT_SM2ID, OPT_SM2HEXID
34 } OPTION_CHOICE;
35
36 const OPTIONS verify_options[] = {
37     {OPT_HELP_STR, 1, '-', "Usage: %s [options] cert.pem...\n"},
38     {OPT_HELP_STR, 1, '-', "Valid options are:\n"},
39     {"help", OPT_HELP, '-', "Display this summary"},
40     {"verbose", OPT_VERBOSE, '-',
41         "Print extra information about the operations being performed."},
42     {"CApath", OPT_CAPATH, '/', "A directory of trusted certificates"},
43     {"CAfile", OPT_CAFILE, '<', "A file of trusted certificates"},
44     {"no-CAfile", OPT_NOCAFILE, '-',
45      "Do not load the default certificates file"},
46     {"no-CApath", OPT_NOCAPATH, '-',
47      "Do not load certificates from the default certificates directory"},
48     {"untrusted", OPT_UNTRUSTED, '<', "A file of untrusted certificates"},
49     {"trusted", OPT_TRUSTED, '<', "A file of trusted certificates"},
50     {"CRLfile", OPT_CRLFILE, '<',
51         "File containing one or more CRL's (in PEM format) to load"},
52     {"crl_download", OPT_CRL_DOWNLOAD, '-',
53         "Attempt to download CRL information for this certificate"},
54     {"show_chain", OPT_SHOW_CHAIN, '-',
55         "Display information about the certificate chain"},
56     {"nameopt", OPT_NAMEOPT, 's', "Various certificate name options"},
57     OPT_V_OPTIONS,
58 #ifndef OPENSSL_NO_ENGINE
59     {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
60 #endif
61 #ifndef OPENSSL_NO_SM2
62     {"sm2-id", OPT_SM2ID, 's',
63      "Specify an ID string to verify an SM2 certificate"},
64     {"sm2-hex-id", OPT_SM2HEXID, 's',
65      "Specify a hex ID string to verify an SM2 certificate"},
66 #endif
67     {NULL}
68 };
69
70 int verify_main(int argc, char **argv)
71 {
72     ENGINE *e = NULL;
73     STACK_OF(X509) *untrusted = NULL, *trusted = NULL;
74     STACK_OF(X509_CRL) *crls = NULL;
75     X509_STORE *store = NULL;
76     X509_VERIFY_PARAM *vpm = NULL;
77     const char *prog, *CApath = NULL, *CAfile = NULL;
78     int noCApath = 0, noCAfile = 0;
79     int vpmtouched = 0, crl_download = 0, show_chain = 0, i = 0, ret = 1;
80     OPTION_CHOICE o;
81     unsigned char *sm2_id = NULL;
82     size_t sm2_idlen = 0;
83     int sm2_free = 0;
84
85     if ((vpm = X509_VERIFY_PARAM_new()) == NULL)
86         goto end;
87
88     prog = opt_init(argc, argv, verify_options);
89     while ((o = opt_next()) != OPT_EOF) {
90         switch (o) {
91         case OPT_EOF:
92         case OPT_ERR:
93             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
94             goto end;
95         case OPT_HELP:
96             opt_help(verify_options);
97             BIO_printf(bio_err, "Recognized usages:\n");
98             for (i = 0; i < X509_PURPOSE_get_count(); i++) {
99                 X509_PURPOSE *ptmp;
100                 ptmp = X509_PURPOSE_get0(i);
101                 BIO_printf(bio_err, "\t%-10s\t%s\n",
102                         X509_PURPOSE_get0_sname(ptmp),
103                         X509_PURPOSE_get0_name(ptmp));
104             }
105
106             BIO_printf(bio_err, "Recognized verify names:\n");
107             for (i = 0; i < X509_VERIFY_PARAM_get_count(); i++) {
108                 const X509_VERIFY_PARAM *vptmp;
109                 vptmp = X509_VERIFY_PARAM_get0(i);
110                 BIO_printf(bio_err, "\t%-10s\n",
111                         X509_VERIFY_PARAM_get0_name(vptmp));
112             }
113             ret = 0;
114             goto end;
115         case OPT_V_CASES:
116             if (!opt_verify(o, vpm))
117                 goto end;
118             vpmtouched++;
119             break;
120         case OPT_CAPATH:
121             CApath = opt_arg();
122             break;
123         case OPT_CAFILE:
124             CAfile = opt_arg();
125             break;
126         case OPT_NOCAPATH:
127             noCApath = 1;
128             break;
129         case OPT_NOCAFILE:
130             noCAfile = 1;
131             break;
132         case OPT_UNTRUSTED:
133             /* Zero or more times */
134             if (!load_certs(opt_arg(), &untrusted, FORMAT_PEM, NULL,
135                             "untrusted certificates"))
136                 goto end;
137             break;
138         case OPT_TRUSTED:
139             /* Zero or more times */
140             noCAfile = 1;
141             noCApath = 1;
142             if (!load_certs(opt_arg(), &trusted, FORMAT_PEM, NULL,
143                             "trusted certificates"))
144                 goto end;
145             break;
146         case OPT_CRLFILE:
147             /* Zero or more times */
148             if (!load_crls(opt_arg(), &crls, FORMAT_PEM, NULL,
149                            "other CRLs"))
150                 goto end;
151             break;
152         case OPT_CRL_DOWNLOAD:
153             crl_download = 1;
154             break;
155         case OPT_ENGINE:
156             if ((e = setup_engine(opt_arg(), 0)) == NULL) {
157                 /* Failure message already displayed */
158                 goto end;
159             }
160             break;
161         case OPT_SHOW_CHAIN:
162             show_chain = 1;
163             break;
164         case OPT_NAMEOPT:
165             if (!set_nameopt(opt_arg()))
166                 goto end;
167             break;
168         case OPT_VERBOSE:
169             v_verbose = 1;
170             break;
171         case OPT_SM2ID:
172             if (sm2_id != NULL) {
173                 BIO_printf(bio_err,
174                            "Use one of the options 'sm2-hex-id' or 'sm2-id' \n");
175                 goto end;
176             }
177             sm2_id = (unsigned char *)opt_arg();
178             sm2_idlen = strlen((const char *)sm2_id);
179             break;
180         case OPT_SM2HEXID:
181             if (sm2_id != NULL) {
182                 BIO_printf(bio_err,
183                            "Use one of the options 'sm2-hex-id' or 'sm2-id' \n");
184                 goto end;
185             }
186             /* try to parse the input as hex string first */
187             sm2_free = 1;
188             sm2_id = OPENSSL_hexstr2buf(opt_arg(), (long *)&sm2_idlen);
189             if (sm2_id == NULL) {
190                 BIO_printf(bio_err, "Invalid hex string input\n");
191                 goto end;
192             }
193             break;
194         }
195     }
196     argc = opt_num_rest();
197     argv = opt_rest();
198     if (trusted != NULL && (CAfile || CApath)) {
199         BIO_printf(bio_err,
200                    "%s: Cannot use -trusted with -CAfile or -CApath\n",
201                    prog);
202         goto end;
203     }
204
205     if ((store = setup_verify(CAfile, CApath, noCAfile, noCApath)) == NULL)
206         goto end;
207     X509_STORE_set_verify_cb(store, cb);
208
209     if (vpmtouched)
210         X509_STORE_set1_param(store, vpm);
211
212     ERR_clear_error();
213
214     if (crl_download)
215         store_setup_crl_download(store);
216
217     ret = 0;
218     if (argc < 1) {
219         if (check(store, NULL, untrusted, trusted, crls, show_chain,
220                   sm2_id, sm2_idlen) != 1)
221             ret = -1;
222     } else {
223         for (i = 0; i < argc; i++)
224             if (check(store, argv[i], untrusted, trusted, crls,
225                       show_chain, sm2_id, sm2_idlen) != 1)
226                 ret = -1;
227     }
228
229  end:
230     if (sm2_free)
231         OPENSSL_free(sm2_id);
232     X509_VERIFY_PARAM_free(vpm);
233     X509_STORE_free(store);
234     sk_X509_pop_free(untrusted, X509_free);
235     sk_X509_pop_free(trusted, X509_free);
236     sk_X509_CRL_pop_free(crls, X509_CRL_free);
237     release_engine(e);
238     return (ret < 0 ? 2 : ret);
239 }
240
241 static int check(X509_STORE *ctx, const char *file,
242                  STACK_OF(X509) *uchain, STACK_OF(X509) *tchain,
243                  STACK_OF(X509_CRL) *crls, int show_chain,
244                  unsigned char *sm2id, size_t sm2idlen)
245 {
246     X509 *x = NULL;
247     int i = 0, ret = 0;
248     X509_STORE_CTX *csc;
249     STACK_OF(X509) *chain = NULL;
250     int num_untrusted;
251
252     x = load_cert(file, FORMAT_PEM, "certificate file");
253     if (x == NULL)
254         goto end;
255
256     if (sm2id != NULL) {
257 #ifndef OPENSSL_NO_SM2
258         ASN1_OCTET_STRING *v;
259
260         v = ASN1_OCTET_STRING_new();
261         if (v == NULL) {
262             BIO_printf(bio_err, "error: SM2 ID allocation failed\n");
263             goto end;
264         }
265
266         if (!ASN1_OCTET_STRING_set(v, sm2id, sm2idlen)) {
267             BIO_printf(bio_err, "error: setting SM2 ID failed\n");
268             ASN1_OCTET_STRING_free(v);
269             goto end;
270         }
271
272         X509_set0_sm2_id(x, v);
273 #endif
274     }
275
276     csc = X509_STORE_CTX_new();
277     if (csc == NULL) {
278         BIO_printf(bio_err, "error %s: X.509 store context allocation failed\n",
279                    (file == NULL) ? "stdin" : file);
280         goto end;
281     }
282
283     X509_STORE_set_flags(ctx, vflags);
284     if (!X509_STORE_CTX_init(csc, ctx, x, uchain)) {
285         X509_STORE_CTX_free(csc);
286         BIO_printf(bio_err,
287                    "error %s: X.509 store context initialization failed\n",
288                    (file == NULL) ? "stdin" : file);
289         goto end;
290     }
291     if (tchain != NULL)
292         X509_STORE_CTX_set0_trusted_stack(csc, tchain);
293     if (crls != NULL)
294         X509_STORE_CTX_set0_crls(csc, crls);
295     i = X509_verify_cert(csc);
296     if (i > 0 && X509_STORE_CTX_get_error(csc) == X509_V_OK) {
297         BIO_printf(bio_out, "%s: OK\n", (file == NULL) ? "stdin" : file);
298         ret = 1;
299         if (show_chain) {
300             int j;
301
302             chain = X509_STORE_CTX_get1_chain(csc);
303             num_untrusted = X509_STORE_CTX_get_num_untrusted(csc);
304             BIO_printf(bio_out, "Chain:\n");
305             for (j = 0; j < sk_X509_num(chain); j++) {
306                 X509 *cert = sk_X509_value(chain, j);
307                 BIO_printf(bio_out, "depth=%d: ", j);
308                 X509_NAME_print_ex_fp(stdout,
309                                       X509_get_subject_name(cert),
310                                       0, get_nameopt());
311                 if (j < num_untrusted)
312                     BIO_printf(bio_out, " (untrusted)");
313                 BIO_printf(bio_out, "\n");
314             }
315             sk_X509_pop_free(chain, X509_free);
316         }
317     } else {
318         BIO_printf(bio_err,
319                    "error %s: verification failed\n",
320                    (file == NULL) ? "stdin" : file);
321     }
322     X509_STORE_CTX_free(csc);
323
324  end:
325     if (i <= 0)
326         ERR_print_errors(bio_err);
327     X509_free(x);
328
329     return ret;
330 }
331
332 static int cb(int ok, X509_STORE_CTX *ctx)
333 {
334     int cert_error = X509_STORE_CTX_get_error(ctx);
335     X509 *current_cert = X509_STORE_CTX_get_current_cert(ctx);
336
337     if (!ok) {
338         if (current_cert != NULL) {
339             X509_NAME_print_ex(bio_err,
340                             X509_get_subject_name(current_cert),
341                             0, get_nameopt());
342             BIO_printf(bio_err, "\n");
343         }
344         BIO_printf(bio_err, "%serror %d at %d depth lookup: %s\n",
345                X509_STORE_CTX_get0_parent_ctx(ctx) ? "[CRL path] " : "",
346                cert_error,
347                X509_STORE_CTX_get_error_depth(ctx),
348                X509_verify_cert_error_string(cert_error));
349
350         /*
351          * Pretend that some errors are ok, so they don't stop further
352          * processing of the certificate chain.  Setting ok = 1 does this.
353          * After X509_verify_cert() is done, we verify that there were
354          * no actual errors, even if the returned value was positive.
355          */
356         switch (cert_error) {
357         case X509_V_ERR_NO_EXPLICIT_POLICY:
358             policies_print(ctx);
359             /* fall thru */
360         case X509_V_ERR_CERT_HAS_EXPIRED:
361             /* Continue even if the leaf is a self signed cert */
362         case X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT:
363             /* Continue after extension errors too */
364         case X509_V_ERR_INVALID_CA:
365         case X509_V_ERR_INVALID_NON_CA:
366         case X509_V_ERR_PATH_LENGTH_EXCEEDED:
367         case X509_V_ERR_INVALID_PURPOSE:
368         case X509_V_ERR_CRL_HAS_EXPIRED:
369         case X509_V_ERR_CRL_NOT_YET_VALID:
370         case X509_V_ERR_UNHANDLED_CRITICAL_EXTENSION:
371             ok = 1;
372         }
373
374         return ok;
375
376     }
377     if (cert_error == X509_V_OK && ok == 2)
378         policies_print(ctx);
379     if (!v_verbose)
380         ERR_clear_error();
381     return ok;
382 }