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