apps: Don't include progs.h in apps.h
[openssl.git] / apps / apps.h
1 /*
2  * Copyright 1995-2017 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (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 #ifndef HEADER_APPS_H
11 # define HEADER_APPS_H
12
13 # include "e_os.h" /* struct timeval for DTLS */
14 # include "internal/nelem.h"
15 # include <assert.h>
16
17 # include <openssl/e_os2.h>
18 # include <openssl/ossl_typ.h>
19 # include <openssl/bio.h>
20 # include <openssl/x509.h>
21 # include <openssl/conf.h>
22 # include <openssl/txt_db.h>
23 # include <openssl/engine.h>
24 # include <openssl/ocsp.h>
25 # include <signal.h>
26
27 # if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_WINCE)
28 #  define openssl_fdset(a,b) FD_SET((unsigned int)a, b)
29 # else
30 #  define openssl_fdset(a,b) FD_SET(a, b)
31 # endif
32
33 /*
34  * quick macro when you need to pass an unsigned char instead of a char.
35  * this is true for some implementations of the is*() functions, for
36  * example.
37  */
38 #define _UC(c) ((unsigned char)(c))
39
40 void app_RAND_load_conf(CONF *c, const char *section);
41 void app_RAND_write(void);
42
43 extern char *default_config_file;
44 extern BIO *bio_in;
45 extern BIO *bio_out;
46 extern BIO *bio_err;
47 extern const unsigned char tls13_aes128gcmsha256_id[];
48 extern const unsigned char tls13_aes256gcmsha384_id[];
49 extern BIO_ADDR *ourpeer;
50
51 BIO *dup_bio_in(int format);
52 BIO *dup_bio_out(int format);
53 BIO *dup_bio_err(int format);
54 BIO *bio_open_owner(const char *filename, int format, int private);
55 BIO *bio_open_default(const char *filename, char mode, int format);
56 BIO *bio_open_default_quiet(const char *filename, char mode, int format);
57 CONF *app_load_config_bio(BIO *in, const char *filename);
58 CONF *app_load_config(const char *filename);
59 CONF *app_load_config_quiet(const char *filename);
60 int app_load_modules(const CONF *config);
61 void unbuffer(FILE *fp);
62 void wait_for_async(SSL *s);
63 # if defined(OPENSSL_SYS_MSDOS)
64 int has_stdin_waiting(void);
65 # endif
66
67 void corrupt_signature(const ASN1_STRING *signature);
68 int set_cert_times(X509 *x, const char *startdate, const char *enddate,
69                    int days);
70
71 /*
72  * Common verification options.
73  */
74 # define OPT_V_ENUM \
75         OPT_V__FIRST=2000, \
76         OPT_V_POLICY, OPT_V_PURPOSE, OPT_V_VERIFY_NAME, OPT_V_VERIFY_DEPTH, \
77         OPT_V_ATTIME, OPT_V_VERIFY_HOSTNAME, OPT_V_VERIFY_EMAIL, \
78         OPT_V_VERIFY_IP, OPT_V_IGNORE_CRITICAL, OPT_V_ISSUER_CHECKS, \
79         OPT_V_CRL_CHECK, OPT_V_CRL_CHECK_ALL, OPT_V_POLICY_CHECK, \
80         OPT_V_EXPLICIT_POLICY, OPT_V_INHIBIT_ANY, OPT_V_INHIBIT_MAP, \
81         OPT_V_X509_STRICT, OPT_V_EXTENDED_CRL, OPT_V_USE_DELTAS, \
82         OPT_V_POLICY_PRINT, OPT_V_CHECK_SS_SIG, OPT_V_TRUSTED_FIRST, \
83         OPT_V_SUITEB_128_ONLY, OPT_V_SUITEB_128, OPT_V_SUITEB_192, \
84         OPT_V_PARTIAL_CHAIN, OPT_V_NO_ALT_CHAINS, OPT_V_NO_CHECK_TIME, \
85         OPT_V_VERIFY_AUTH_LEVEL, OPT_V_ALLOW_PROXY_CERTS, \
86         OPT_V__LAST
87
88 # define OPT_V_OPTIONS \
89         { "policy", OPT_V_POLICY, 's', "adds policy to the acceptable policy set"}, \
90         { "purpose", OPT_V_PURPOSE, 's', \
91             "certificate chain purpose"}, \
92         { "verify_name", OPT_V_VERIFY_NAME, 's', "verification policy name"}, \
93         { "verify_depth", OPT_V_VERIFY_DEPTH, 'n', \
94             "chain depth limit" }, \
95         { "auth_level", OPT_V_VERIFY_AUTH_LEVEL, 'n', \
96             "chain authentication security level" }, \
97         { "attime", OPT_V_ATTIME, 'M', "verification epoch time" }, \
98         { "verify_hostname", OPT_V_VERIFY_HOSTNAME, 's', \
99             "expected peer hostname" }, \
100         { "verify_email", OPT_V_VERIFY_EMAIL, 's', \
101             "expected peer email" }, \
102         { "verify_ip", OPT_V_VERIFY_IP, 's', \
103             "expected peer IP address" }, \
104         { "ignore_critical", OPT_V_IGNORE_CRITICAL, '-', \
105             "permit unhandled critical extensions"}, \
106         { "issuer_checks", OPT_V_ISSUER_CHECKS, '-', "(deprecated)"}, \
107         { "crl_check", OPT_V_CRL_CHECK, '-', "check leaf certificate revocation" }, \
108         { "crl_check_all", OPT_V_CRL_CHECK_ALL, '-', "check full chain revocation" }, \
109         { "policy_check", OPT_V_POLICY_CHECK, '-', "perform rfc5280 policy checks"}, \
110         { "explicit_policy", OPT_V_EXPLICIT_POLICY, '-', \
111             "set policy variable require-explicit-policy"}, \
112         { "inhibit_any", OPT_V_INHIBIT_ANY, '-', \
113             "set policy variable inhibit-any-policy"}, \
114         { "inhibit_map", OPT_V_INHIBIT_MAP, '-', \
115             "set policy variable inhibit-policy-mapping"}, \
116         { "x509_strict", OPT_V_X509_STRICT, '-', \
117             "disable certificate compatibility work-arounds"}, \
118         { "extended_crl", OPT_V_EXTENDED_CRL, '-', \
119             "enable extended CRL features"}, \
120         { "use_deltas", OPT_V_USE_DELTAS, '-', \
121             "use delta CRLs"}, \
122         { "policy_print", OPT_V_POLICY_PRINT, '-', \
123             "print policy processing diagnostics"}, \
124         { "check_ss_sig", OPT_V_CHECK_SS_SIG, '-', \
125             "check root CA self-signatures"}, \
126         { "trusted_first", OPT_V_TRUSTED_FIRST, '-', \
127             "search trust store first (default)" }, \
128         { "suiteB_128_only", OPT_V_SUITEB_128_ONLY, '-', "Suite B 128-bit-only mode"}, \
129         { "suiteB_128", OPT_V_SUITEB_128, '-', \
130             "Suite B 128-bit mode allowing 192-bit algorithms"}, \
131         { "suiteB_192", OPT_V_SUITEB_192, '-', "Suite B 192-bit-only mode" }, \
132         { "partial_chain", OPT_V_PARTIAL_CHAIN, '-', \
133             "accept chains anchored by intermediate trust-store CAs"}, \
134         { "no_alt_chains", OPT_V_NO_ALT_CHAINS, '-', "(deprecated)" }, \
135         { "no_check_time", OPT_V_NO_CHECK_TIME, '-', "ignore certificate validity time" }, \
136         { "allow_proxy_certs", OPT_V_ALLOW_PROXY_CERTS, '-', "allow the use of proxy certificates" }
137
138 # define OPT_V_CASES \
139         OPT_V__FIRST: case OPT_V__LAST: break; \
140         case OPT_V_POLICY: \
141         case OPT_V_PURPOSE: \
142         case OPT_V_VERIFY_NAME: \
143         case OPT_V_VERIFY_DEPTH: \
144         case OPT_V_VERIFY_AUTH_LEVEL: \
145         case OPT_V_ATTIME: \
146         case OPT_V_VERIFY_HOSTNAME: \
147         case OPT_V_VERIFY_EMAIL: \
148         case OPT_V_VERIFY_IP: \
149         case OPT_V_IGNORE_CRITICAL: \
150         case OPT_V_ISSUER_CHECKS: \
151         case OPT_V_CRL_CHECK: \
152         case OPT_V_CRL_CHECK_ALL: \
153         case OPT_V_POLICY_CHECK: \
154         case OPT_V_EXPLICIT_POLICY: \
155         case OPT_V_INHIBIT_ANY: \
156         case OPT_V_INHIBIT_MAP: \
157         case OPT_V_X509_STRICT: \
158         case OPT_V_EXTENDED_CRL: \
159         case OPT_V_USE_DELTAS: \
160         case OPT_V_POLICY_PRINT: \
161         case OPT_V_CHECK_SS_SIG: \
162         case OPT_V_TRUSTED_FIRST: \
163         case OPT_V_SUITEB_128_ONLY: \
164         case OPT_V_SUITEB_128: \
165         case OPT_V_SUITEB_192: \
166         case OPT_V_PARTIAL_CHAIN: \
167         case OPT_V_NO_ALT_CHAINS: \
168         case OPT_V_NO_CHECK_TIME: \
169         case OPT_V_ALLOW_PROXY_CERTS
170
171 /*
172  * Common "extended validation" options.
173  */
174 # define OPT_X_ENUM \
175         OPT_X__FIRST=1000, \
176         OPT_X_KEY, OPT_X_CERT, OPT_X_CHAIN, OPT_X_CHAIN_BUILD, \
177         OPT_X_CERTFORM, OPT_X_KEYFORM, \
178         OPT_X__LAST
179
180 # define OPT_X_OPTIONS \
181         { "xkey", OPT_X_KEY, '<', "key for Extended certificates"}, \
182         { "xcert", OPT_X_CERT, '<', "cert for Extended certificates"}, \
183         { "xchain", OPT_X_CHAIN, '<', "chain for Extended certificates"}, \
184         { "xchain_build", OPT_X_CHAIN_BUILD, '-', \
185             "build certificate chain for the extended certificates"}, \
186         { "xcertform", OPT_X_CERTFORM, 'F', \
187             "format of Extended certificate (PEM or DER) PEM default " }, \
188         { "xkeyform", OPT_X_KEYFORM, 'F', \
189             "format of Extended certificate's key (PEM or DER) PEM default"}
190
191 # define OPT_X_CASES \
192         OPT_X__FIRST: case OPT_X__LAST: break; \
193         case OPT_X_KEY: \
194         case OPT_X_CERT: \
195         case OPT_X_CHAIN: \
196         case OPT_X_CHAIN_BUILD: \
197         case OPT_X_CERTFORM: \
198         case OPT_X_KEYFORM
199
200 /*
201  * Common SSL options.
202  * Any changes here must be coordinated with ../ssl/ssl_conf.c
203  */
204 # define OPT_S_ENUM \
205         OPT_S__FIRST=3000, \
206         OPT_S_NOSSL3, OPT_S_NOTLS1, OPT_S_NOTLS1_1, OPT_S_NOTLS1_2, \
207         OPT_S_NOTLS1_3, OPT_S_BUGS, OPT_S_NO_COMP, OPT_S_NOTICKET, \
208         OPT_S_SERVERPREF, OPT_S_LEGACYRENEG, OPT_S_LEGACYCONN, \
209         OPT_S_ONRESUMP, OPT_S_NOLEGACYCONN, OPT_S_ALLOW_NO_DHE_KEX, \
210         OPT_S_PRIORITIZE_CHACHA, \
211         OPT_S_STRICT, OPT_S_SIGALGS, OPT_S_CLIENTSIGALGS, OPT_S_GROUPS, \
212         OPT_S_CURVES, OPT_S_NAMEDCURVE, OPT_S_CIPHER, \
213         OPT_S_RECORD_PADDING, OPT_S_DEBUGBROKE, OPT_S_COMP, \
214         OPT_S_NO_RENEGOTIATION, OPT_S_NO_MIDDLEBOX, OPT_S__LAST
215
216 # define OPT_S_OPTIONS \
217         {"no_ssl3", OPT_S_NOSSL3, '-',"Just disable SSLv3" }, \
218         {"no_tls1", OPT_S_NOTLS1, '-', "Just disable TLSv1"}, \
219         {"no_tls1_1", OPT_S_NOTLS1_1, '-', "Just disable TLSv1.1" }, \
220         {"no_tls1_2", OPT_S_NOTLS1_2, '-', "Just disable TLSv1.2"}, \
221         {"no_tls1_3", OPT_S_NOTLS1_3, '-', "Just disable TLSv1.3"}, \
222         {"bugs", OPT_S_BUGS, '-', "Turn on SSL bug compatibility"}, \
223         {"no_comp", OPT_S_NO_COMP, '-', "Disable SSL/TLS compression (default)" }, \
224         {"comp", OPT_S_COMP, '-', "Use SSL/TLS-level compression" }, \
225         {"no_ticket", OPT_S_NOTICKET, '-', \
226             "Disable use of TLS session tickets"}, \
227         {"serverpref", OPT_S_SERVERPREF, '-', "Use server's cipher preferences"}, \
228         {"legacy_renegotiation", OPT_S_LEGACYRENEG, '-', \
229             "Enable use of legacy renegotiation (dangerous)"}, \
230         {"no_renegotiation", OPT_S_NO_RENEGOTIATION, '-', \
231             "Disable all renegotiation."}, \
232         {"legacy_server_connect", OPT_S_LEGACYCONN, '-', \
233             "Allow initial connection to servers that don't support RI"}, \
234         {"no_resumption_on_reneg", OPT_S_ONRESUMP, '-', \
235             "Disallow session resumption on renegotiation"}, \
236         {"no_legacy_server_connect", OPT_S_NOLEGACYCONN, '-', \
237             "Disallow initial connection to servers that don't support RI"}, \
238         {"allow_no_dhe_kex", OPT_S_ALLOW_NO_DHE_KEX, '-', \
239             "In TLSv1.3 allow non-(ec)dhe based key exchange on resumption"}, \
240         {"prioritize_chacha", OPT_S_PRIORITIZE_CHACHA, '-', \
241             "Prioritize ChaCha ciphers when preferred by clients"}, \
242         {"strict", OPT_S_STRICT, '-', \
243             "Enforce strict certificate checks as per TLS standard"}, \
244         {"sigalgs", OPT_S_SIGALGS, 's', \
245             "Signature algorithms to support (colon-separated list)" }, \
246         {"client_sigalgs", OPT_S_CLIENTSIGALGS, 's', \
247             "Signature algorithms to support for client certificate" \
248             " authentication (colon-separated list)" }, \
249         {"groups", OPT_S_GROUPS, 's', \
250             "Groups to advertise (colon-separated list)" }, \
251         {"curves", OPT_S_CURVES, 's', \
252             "Groups to advertise (colon-separated list)" }, \
253         {"named_curve", OPT_S_NAMEDCURVE, 's', \
254             "Elliptic curve used for ECDHE (server-side only)" }, \
255         {"cipher", OPT_S_CIPHER, 's', "Specify cipher list to be used"}, \
256         {"record_padding", OPT_S_RECORD_PADDING, 's', \
257             "Block size to pad TLS 1.3 records to."}, \
258         {"debug_broken_protocol", OPT_S_DEBUGBROKE, '-', \
259             "Perform all sorts of protocol violations for testing purposes"}, \
260         {"no_middlebox", OPT_S_NO_MIDDLEBOX, '-', "Disable TLSv1.3 middlebox compat mode" }
261
262
263 # define OPT_S_CASES \
264         OPT_S__FIRST: case OPT_S__LAST: break; \
265         case OPT_S_NOSSL3: \
266         case OPT_S_NOTLS1: \
267         case OPT_S_NOTLS1_1: \
268         case OPT_S_NOTLS1_2: \
269         case OPT_S_NOTLS1_3: \
270         case OPT_S_BUGS: \
271         case OPT_S_NO_COMP: \
272         case OPT_S_COMP: \
273         case OPT_S_NOTICKET: \
274         case OPT_S_SERVERPREF: \
275         case OPT_S_LEGACYRENEG: \
276         case OPT_S_LEGACYCONN: \
277         case OPT_S_ONRESUMP: \
278         case OPT_S_NOLEGACYCONN: \
279         case OPT_S_ALLOW_NO_DHE_KEX: \
280         case OPT_S_PRIORITIZE_CHACHA: \
281         case OPT_S_STRICT: \
282         case OPT_S_SIGALGS: \
283         case OPT_S_CLIENTSIGALGS: \
284         case OPT_S_GROUPS: \
285         case OPT_S_CURVES: \
286         case OPT_S_NAMEDCURVE: \
287         case OPT_S_CIPHER: \
288         case OPT_S_RECORD_PADDING: \
289         case OPT_S_NO_RENEGOTIATION: \
290         case OPT_S_DEBUGBROKE: \
291         case OPT_S_NO_MIDDLEBOX
292
293 #define IS_NO_PROT_FLAG(o) \
294  (o == OPT_S_NOSSL3 || o == OPT_S_NOTLS1 || o == OPT_S_NOTLS1_1 \
295   || o == OPT_S_NOTLS1_2 || o == OPT_S_NOTLS1_3)
296
297 /*
298  * Random state options.
299  */
300 # define OPT_R_ENUM \
301         OPT_R__FIRST=1500, OPT_R_RAND, OPT_R_WRITERAND, OPT_R__LAST
302
303 # define OPT_R_OPTIONS \
304     {"rand", OPT_R_RAND, 's', "Load the file(s) into the random number generator"}, \
305     {"writerand", OPT_R_WRITERAND, '>', "Write random data to the specified file"}
306
307 # define OPT_R_CASES \
308         OPT_R__FIRST: case OPT_R__LAST: break; \
309         case OPT_R_RAND: case OPT_R_WRITERAND
310
311 /*
312  * Option parsing.
313  */
314 extern const char OPT_HELP_STR[];
315 extern const char OPT_MORE_STR[];
316 typedef struct options_st {
317     const char *name;
318     int retval;
319     /*
320      * value type: - no value (also the value zero), n number, p positive
321      * number, u unsigned, l long, s string, < input file, > output file,
322      * f any format, F der/pem format, E der/pem/engine format identifier.
323      * l, n and u include zero; p does not.
324      */
325     int valtype;
326     const char *helpstr;
327 } OPTIONS;
328
329 /*
330  * A string/int pairing; widely use for option value lookup, hence the
331  * name OPT_PAIR. But that name is misleading in s_cb.c, so we also use
332  * the "generic" name STRINT_PAIR.
333  */
334 typedef struct string_int_pair_st {
335     const char *name;
336     int retval;
337 } OPT_PAIR, STRINT_PAIR;
338
339 /* Flags to pass into opt_format; see FORMAT_xxx, below. */
340 # define OPT_FMT_PEMDER          (1L <<  1)
341 # define OPT_FMT_PKCS12          (1L <<  2)
342 # define OPT_FMT_SMIME           (1L <<  3)
343 # define OPT_FMT_ENGINE          (1L <<  4)
344 # define OPT_FMT_MSBLOB          (1L <<  5)
345 # define OPT_FMT_NETSCAPE        (1L <<  6)
346 # define OPT_FMT_NSS             (1L <<  7)
347 # define OPT_FMT_TEXT            (1L <<  8)
348 # define OPT_FMT_HTTP            (1L <<  9)
349 # define OPT_FMT_PVK             (1L << 10)
350 # define OPT_FMT_PDE     (OPT_FMT_PEMDER | OPT_FMT_ENGINE)
351 # define OPT_FMT_PDS     (OPT_FMT_PEMDER | OPT_FMT_SMIME)
352 # define OPT_FMT_ANY     ( \
353         OPT_FMT_PEMDER | OPT_FMT_PKCS12 | OPT_FMT_SMIME | \
354         OPT_FMT_ENGINE | OPT_FMT_MSBLOB | OPT_FMT_NETSCAPE | \
355         OPT_FMT_NSS | OPT_FMT_TEXT | OPT_FMT_HTTP | OPT_FMT_PVK)
356
357 char *opt_progname(const char *argv0);
358 char *opt_getprog(void);
359 char *opt_init(int ac, char **av, const OPTIONS * o);
360 int opt_next(void);
361 int opt_format(const char *s, unsigned long flags, int *result);
362 int opt_int(const char *arg, int *result);
363 int opt_ulong(const char *arg, unsigned long *result);
364 int opt_long(const char *arg, long *result);
365 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L && \
366     defined(INTMAX_MAX) && defined(UINTMAX_MAX)
367 int opt_imax(const char *arg, intmax_t *result);
368 int opt_umax(const char *arg, uintmax_t *result);
369 #else
370 # define opt_imax opt_long
371 # define opt_umax opt_ulong
372 # define intmax_t long
373 # define uintmax_t unsigned long
374 #endif
375 int opt_pair(const char *arg, const OPT_PAIR * pairs, int *result);
376 int opt_cipher(const char *name, const EVP_CIPHER **cipherp);
377 int opt_md(const char *name, const EVP_MD **mdp);
378 char *opt_arg(void);
379 char *opt_flag(void);
380 char *opt_unknown(void);
381 char **opt_rest(void);
382 int opt_num_rest(void);
383 int opt_verify(int i, X509_VERIFY_PARAM *vpm);
384 int opt_rand(int i);
385 void opt_help(const OPTIONS * list);
386 int opt_format_error(const char *s, unsigned long flags);
387
388 typedef struct args_st {
389     int size;
390     int argc;
391     char **argv;
392 } ARGS;
393
394 /*
395  * VMS C only for now, implemented in vms_decc_init.c
396  * If other C compilers forget to terminate argv with NULL, this function
397  * can be re-used.
398  */
399 char **copy_argv(int *argc, char *argv[]);
400 /*
401  * Win32-specific argv initialization that splits OS-supplied UNICODE
402  * command line string to array of UTF8-encoded strings.
403  */
404 void win32_utf8argv(int *argc, char **argv[]);
405
406
407 # define PW_MIN_LENGTH 4
408 typedef struct pw_cb_data {
409     const void *password;
410     const char *prompt_info;
411 } PW_CB_DATA;
412
413 int password_callback(char *buf, int bufsiz, int verify, PW_CB_DATA *cb_data);
414
415 int setup_ui_method(void);
416 void destroy_ui_method(void);
417 const UI_METHOD *get_ui_method(void);
418
419 int chopup_args(ARGS *arg, char *buf);
420 # ifdef HEADER_X509_H
421 int dump_cert_text(BIO *out, X509 *x);
422 void print_name(BIO *out, const char *title, X509_NAME *nm,
423                 unsigned long lflags);
424 # endif
425 void print_bignum_var(BIO *, const BIGNUM *, const char*,
426                       int, unsigned char *);
427 void print_array(BIO *, const char *, int, const unsigned char *);
428 int set_nameopt(const char *arg);
429 unsigned long get_nameopt(void);
430 int set_cert_ex(unsigned long *flags, const char *arg);
431 int set_name_ex(unsigned long *flags, const char *arg);
432 int set_ext_copy(int *copy_type, const char *arg);
433 int copy_extensions(X509 *x, X509_REQ *req, int copy_type);
434 int app_passwd(const char *arg1, const char *arg2, char **pass1, char **pass2);
435 int add_oid_section(CONF *conf);
436 X509 *load_cert(const char *file, int format, const char *cert_descrip);
437 X509_CRL *load_crl(const char *infile, int format);
438 EVP_PKEY *load_key(const char *file, int format, int maybe_stdin,
439                    const char *pass, ENGINE *e, const char *key_descrip);
440 EVP_PKEY *load_pubkey(const char *file, int format, int maybe_stdin,
441                       const char *pass, ENGINE *e, const char *key_descrip);
442 int load_certs(const char *file, STACK_OF(X509) **certs, int format,
443                const char *pass, const char *cert_descrip);
444 int load_crls(const char *file, STACK_OF(X509_CRL) **crls, int format,
445               const char *pass, const char *cert_descrip);
446 X509_STORE *setup_verify(const char *CAfile, const char *CApath,
447                          int noCAfile, int noCApath);
448 __owur int ctx_set_verify_locations(SSL_CTX *ctx, const char *CAfile,
449                                     const char *CApath, int noCAfile,
450                                     int noCApath);
451
452 #ifndef OPENSSL_NO_CT
453
454 /*
455  * Sets the file to load the Certificate Transparency log list from.
456  * If path is NULL, loads from the default file path.
457  * Returns 1 on success, 0 otherwise.
458  */
459 __owur int ctx_set_ctlog_list_file(SSL_CTX *ctx, const char *path);
460
461 #endif
462
463 ENGINE *setup_engine(const char *engine, int debug);
464 void release_engine(ENGINE *e);
465
466 # ifndef OPENSSL_NO_OCSP
467 OCSP_RESPONSE *process_responder(OCSP_REQUEST *req,
468                                  const char *host, const char *path,
469                                  const char *port, int use_ssl,
470                                  STACK_OF(CONF_VALUE) *headers,
471                                  int req_timeout);
472 # endif
473
474 /* Functions defined in ca.c and also used in ocsp.c */
475 int unpack_revinfo(ASN1_TIME **prevtm, int *preason, ASN1_OBJECT **phold,
476                    ASN1_GENERALIZEDTIME **pinvtm, const char *str);
477
478 # define DB_type         0
479 # define DB_exp_date     1
480 # define DB_rev_date     2
481 # define DB_serial       3      /* index - unique */
482 # define DB_file         4
483 # define DB_name         5      /* index - unique when active and not
484                                  * disabled */
485 # define DB_NUMBER       6
486
487 # define DB_TYPE_REV     'R'    /* Revoked  */
488 # define DB_TYPE_EXP     'E'    /* Expired  */
489 # define DB_TYPE_VAL     'V'    /* Valid ; inserted with: ca ... -valid */
490 # define DB_TYPE_SUSP    'S'    /* Suspended  */
491
492 typedef struct db_attr_st {
493     int unique_subject;
494 } DB_ATTR;
495 typedef struct ca_db_st {
496     DB_ATTR attributes;
497     TXT_DB *db;
498 } CA_DB;
499
500 void* app_malloc(int sz, const char *what);
501 BIGNUM *load_serial(const char *serialfile, int create, ASN1_INTEGER **retai);
502 int save_serial(const char *serialfile, const char *suffix, const BIGNUM *serial,
503                 ASN1_INTEGER **retai);
504 int rotate_serial(const char *serialfile, const char *new_suffix,
505                   const char *old_suffix);
506 int rand_serial(BIGNUM *b, ASN1_INTEGER *ai);
507 CA_DB *load_index(const char *dbfile, DB_ATTR *dbattr);
508 int index_index(CA_DB *db);
509 int save_index(const char *dbfile, const char *suffix, CA_DB *db);
510 int rotate_index(const char *dbfile, const char *new_suffix,
511                  const char *old_suffix);
512 void free_index(CA_DB *db);
513 # define index_name_cmp_noconst(a, b) \
514         index_name_cmp((const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, a), \
515         (const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, b))
516 int index_name_cmp(const OPENSSL_CSTRING *a, const OPENSSL_CSTRING *b);
517 int parse_yesno(const char *str, int def);
518
519 X509_NAME *parse_name(const char *str, long chtype, int multirdn);
520 void policies_print(X509_STORE_CTX *ctx);
521 int bio_to_mem(unsigned char **out, int maxlen, BIO *in);
522 int pkey_ctrl_string(EVP_PKEY_CTX *ctx, const char *value);
523 int init_gen_str(EVP_PKEY_CTX **pctx,
524                  const char *algname, ENGINE *e, int do_param);
525 int do_X509_sign(X509 *x, EVP_PKEY *pkey, const EVP_MD *md,
526                  STACK_OF(OPENSSL_STRING) *sigopts);
527 int do_X509_REQ_sign(X509_REQ *x, EVP_PKEY *pkey, const EVP_MD *md,
528                      STACK_OF(OPENSSL_STRING) *sigopts);
529 int do_X509_CRL_sign(X509_CRL *x, EVP_PKEY *pkey, const EVP_MD *md,
530                      STACK_OF(OPENSSL_STRING) *sigopts);
531
532 extern char *psk_key;
533
534
535 unsigned char *next_protos_parse(size_t *outlen, const char *in);
536
537 void print_cert_checks(BIO *bio, X509 *x,
538                        const char *checkhost,
539                        const char *checkemail, const char *checkip);
540
541 void store_setup_crl_download(X509_STORE *st);
542
543 /* See OPT_FMT_xxx, above. */
544 /* On some platforms, it's important to distinguish between text and binary
545  * files.  On some, there might even be specific file formats for different
546  * contents.  The FORMAT_xxx macros are meant to express an intent with the
547  * file being read or created.
548  */
549 # define B_FORMAT_TEXT   0x8000
550 # define FORMAT_UNDEF    0
551 # define FORMAT_TEXT    (1 | B_FORMAT_TEXT)     /* Generic text */
552 # define FORMAT_BINARY   2                      /* Generic binary */
553 # define FORMAT_BASE64  (3 | B_FORMAT_TEXT)     /* Base64 */
554 # define FORMAT_ASN1     4                      /* ASN.1/DER */
555 # define FORMAT_PEM     (5 | B_FORMAT_TEXT)
556 # define FORMAT_PKCS12   6
557 # define FORMAT_SMIME   (7 | B_FORMAT_TEXT)
558 # define FORMAT_ENGINE   8                      /* Not really a file format */
559 # define FORMAT_PEMRSA  (9 | B_FORMAT_TEXT)     /* PEM RSAPubicKey format */
560 # define FORMAT_ASN1RSA  10                     /* DER RSAPubicKey format */
561 # define FORMAT_MSBLOB   11                     /* MS Key blob format */
562 # define FORMAT_PVK      12                     /* MS PVK file format */
563 # define FORMAT_HTTP     13                     /* Download using HTTP */
564 # define FORMAT_NSS      14                     /* NSS keylog format */
565
566 # define EXT_COPY_NONE   0
567 # define EXT_COPY_ADD    1
568 # define EXT_COPY_ALL    2
569
570 # define NETSCAPE_CERT_HDR       "certificate"
571
572 # define APP_PASS_LEN    1024
573
574 /*
575  * IETF RFC 5280 says serial number must be <= 20 bytes. Use 159 bits
576  * so that the first bit will never be one, so that the DER encoding
577  * rules won't force a leading octet.
578  */
579 # define SERIAL_RAND_BITS        159
580
581 int app_isdir(const char *);
582 int app_access(const char *, int flag);
583 int fileno_stdin(void);
584 int fileno_stdout(void);
585 int raw_read_stdin(void *, int);
586 int raw_write_stdout(const void *, int);
587
588 # define TM_START        0
589 # define TM_STOP         1
590 double app_tminterval(int stop, int usertime);
591
592 void make_uppercase(char *string);
593
594 typedef struct verify_options_st {
595     int depth;
596     int quiet;
597     int error;
598     int return_error;
599 } VERIFY_CB_ARGS;
600
601 extern VERIFY_CB_ARGS verify_args;
602
603 #endif