GH646: Update help for s_server command.
[openssl.git] / apps / apps.h
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57 /* ====================================================================
58  * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
59  *
60  * Redistribution and use in source and binary forms, with or without
61  * modification, are permitted provided that the following conditions
62  * are met:
63  *
64  * 1. Redistributions of source code must retain the above copyright
65  *    notice, this list of conditions and the following disclaimer.
66  *
67  * 2. Redistributions in binary form must reproduce the above copyright
68  *    notice, this list of conditions and the following disclaimer in
69  *    the documentation and/or other materials provided with the
70  *    distribution.
71  *
72  * 3. All advertising materials mentioning features or use of this
73  *    software must display the following acknowledgment:
74  *    "This product includes software developed by the OpenSSL Project
75  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
76  *
77  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78  *    endorse or promote products derived from this software without
79  *    prior written permission. For written permission, please contact
80  *    openssl-core@openssl.org.
81  *
82  * 5. Products derived from this software may not be called "OpenSSL"
83  *    nor may "OpenSSL" appear in their names without prior written
84  *    permission of the OpenSSL Project.
85  *
86  * 6. Redistributions of any form whatsoever must retain the following
87  *    acknowledgment:
88  *    "This product includes software developed by the OpenSSL Project
89  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
90  *
91  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
95  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102  * OF THE POSSIBILITY OF SUCH DAMAGE.
103  * ====================================================================
104  *
105  * This product includes cryptographic software written by Eric Young
106  * (eay@cryptsoft.com).  This product includes software written by Tim
107  * Hudson (tjh@cryptsoft.com).
108  *
109  */
110
111 #ifndef HEADER_APPS_H
112 # define HEADER_APPS_H
113
114 # include "e_os.h"
115 # include <assert.h>
116
117 # include <openssl/e_os2.h>
118 # include <openssl/ossl_typ.h>
119 # include <openssl/bio.h>
120 # include <openssl/x509.h>
121 # include <openssl/lhash.h>
122 # include <openssl/conf.h>
123 # include <openssl/txt_db.h>
124 # ifndef OPENSSL_NO_ENGINE
125 #  include <openssl/engine.h>
126 # endif
127 # ifndef OPENSSL_NO_OCSP
128 #  include <openssl/ocsp.h>
129 # endif
130 # include <openssl/ossl_typ.h>
131 # ifndef OPENSSL_SYS_NETWARE
132 #  include <signal.h>
133 # endif
134
135 # if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_WINCE)
136 #  define openssl_fdset(a,b) FD_SET((unsigned int)a, b)
137 # else
138 #  define openssl_fdset(a,b) FD_SET(a, b)
139 # endif
140
141 # if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L && \
142      defined(INTMAX_MAX) && defined(UINTMAX_MAX)
143 int opt_imax(const char *value, intmax_t *result);
144 int opt_umax(const char *value, uintmax_t *result);
145 # else
146 #  define opt_imax opt_long
147 #  define opt_umax opt_ulong
148 #  define intmax_t long
149 #  define uintmax_t unsigned long
150 # endif
151
152 int app_RAND_load_file(const char *file, int dont_warn);
153 int app_RAND_write_file(const char *file);
154 /*
155  * When `file' is NULL, use defaults. `bio_e' is for error messages.
156  */
157 void app_RAND_allow_write_file(void);
158 long app_RAND_load_files(char *file); /* `file' is a list of files to read,
159                                        * separated by LIST_SEPARATOR_CHAR
160                                        * (see e_os.h).  The string is
161                                        * destroyed! */
162
163 extern char *default_config_file;
164 extern BIO *bio_in;
165 extern BIO *bio_out;
166 extern BIO *bio_err;
167 BIO *dup_bio_in(int format);
168 BIO *dup_bio_out(int format);
169 BIO *bio_open_owner(const char *filename, int format, int private);
170 BIO *bio_open_default(const char *filename, char mode, int format);
171 BIO *bio_open_default_quiet(const char *filename, char mode, int format);
172 CONF *app_load_config(const char *filename);
173 CONF *app_load_config_quiet(const char *filename);
174 int app_load_modules(const CONF *config);
175 void unbuffer(FILE *fp);
176 void wait_for_async(SSL *s);
177
178 /*
179  * Common verification options.
180  */
181 # define OPT_V_ENUM \
182         OPT_V__FIRST=2000, \
183         OPT_V_POLICY, OPT_V_PURPOSE, OPT_V_VERIFY_NAME, OPT_V_VERIFY_DEPTH, \
184         OPT_V_ATTIME, OPT_V_VERIFY_HOSTNAME, OPT_V_VERIFY_EMAIL, \
185         OPT_V_VERIFY_IP, OPT_V_IGNORE_CRITICAL, OPT_V_ISSUER_CHECKS, \
186         OPT_V_CRL_CHECK, OPT_V_CRL_CHECK_ALL, OPT_V_POLICY_CHECK, \
187         OPT_V_EXPLICIT_POLICY, OPT_V_INHIBIT_ANY, OPT_V_INHIBIT_MAP, \
188         OPT_V_X509_STRICT, OPT_V_EXTENDED_CRL, OPT_V_USE_DELTAS, \
189         OPT_V_POLICY_PRINT, OPT_V_CHECK_SS_SIG, OPT_V_TRUSTED_FIRST, \
190         OPT_V_SUITEB_128_ONLY, OPT_V_SUITEB_128, OPT_V_SUITEB_192, \
191         OPT_V_PARTIAL_CHAIN, OPT_V_NO_ALT_CHAINS, OPT_V_NO_CHECK_TIME, \
192         OPT_V__LAST
193
194 # define OPT_V_OPTIONS \
195         { "policy", OPT_V_POLICY, 's', "adds policy to the acceptable policy set"}, \
196         { "purpose", OPT_V_PURPOSE, 's', \
197             "Set the acceptable purpose of the certificate chain"}, \
198         { "verify_name", OPT_V_VERIFY_NAME, 's', "verify name"}, \
199         { "verify_depth", OPT_V_VERIFY_DEPTH, 'p', \
200             "Limit the maximum depth of the certificate chain"}, \
201         { "attime", OPT_V_ATTIME, 'M', "Set the verification time" }, \
202         { "verify_hostname", OPT_V_VERIFY_HOSTNAME, 's', \
203             "check peer certificate matches \"host\"" }, \
204         { "verify_email", OPT_V_VERIFY_EMAIL, 's', \
205             "check peer certificate matches \"email\"" }, \
206         { "verify_ip", OPT_V_VERIFY_IP, 's', \
207             "check peer certificate matches \"ipaddr\"" }, \
208         { "ignore_critical", OPT_V_IGNORE_CRITICAL, '-', \
209             "Disable critical extension checking"}, \
210         { "issuer_checks", OPT_V_ISSUER_CHECKS, '-', \
211             "Enable debugging of certificate issuer checks"}, \
212         { "crl_check", OPT_V_CRL_CHECK, '-', "Check that peer cert has not been revoked" }, \
213         { "crl_check_all", OPT_V_CRL_CHECK_ALL, '-', "Also check all certs in the chain" }, \
214         { "policy_check", OPT_V_POLICY_CHECK, '-', "Enable certificate policy checking"}, \
215         { "explicit_policy", OPT_V_EXPLICIT_POLICY, '-', "Set the \"require explicit policy\""}, \
216         { "inhibit_any", OPT_V_INHIBIT_ANY, '-', "Set the \"inhibit any policy\"\""}, \
217         { "inhibit_map", OPT_V_INHIBIT_MAP, '-', "Set the \"inhibit policy mapping\"" }, \
218         { "x509_strict", OPT_V_X509_STRICT, '-', \
219             "Strictly apply X509 rules in verification"}, \
220         { "extended_crl", OPT_V_EXTENDED_CRL, '-', \
221             "Enable extended CRL features such as indirect CRLs, alternate CRL signing keys"}, \
222         { "use_deltas", OPT_V_USE_DELTAS, '-', \
223             "Enable indirect CRLs and CRLs signed by different keys"}, \
224         { "policy_print", OPT_V_POLICY_PRINT, '-', "Notify callback that policy is OK"}, \
225         { "check_ss_sig", OPT_V_CHECK_SS_SIG, '-', \
226             "Enable checking of the root CA self signed certificate signature"}, \
227         { "trusted_first", OPT_V_TRUSTED_FIRST, '-', \
228             "Use locally-trusted CA's first in building chain (enabled by default)" }, \
229         { "suiteB_128_only", OPT_V_SUITEB_128_ONLY, '-', "Suite B 128 bit only mode"}, \
230         { "suiteB_128", OPT_V_SUITEB_128, '-', \
231             "Suite B 128 bit mode allowing 192 bit algorithms"}, \
232         { "suiteB_192", OPT_V_SUITEB_192, '-', "Suite B 192 bit only mode" }, \
233         { "partial_chain", OPT_V_PARTIAL_CHAIN, '-', \
234             "verification succeeds even if a complete chain cannot be built, "}, \
235         {OPT_MORE_STR, 0, 0, "provided a chain to a trusted certificate can be constructed"}, \
236         { "no_alt_chains", OPT_V_NO_ALT_CHAINS, '-', "Only use the first cert chain found" }, \
237         { "no_check_time", OPT_V_NO_CHECK_TIME, '-', "Do not check validity against current time" }
238
239 # define OPT_V_CASES \
240         OPT_V__FIRST: case OPT_V__LAST: break; \
241         case OPT_V_POLICY: \
242         case OPT_V_PURPOSE: \
243         case OPT_V_VERIFY_NAME: \
244         case OPT_V_VERIFY_DEPTH: \
245         case OPT_V_ATTIME: \
246         case OPT_V_VERIFY_HOSTNAME: \
247         case OPT_V_VERIFY_EMAIL: \
248         case OPT_V_VERIFY_IP: \
249         case OPT_V_IGNORE_CRITICAL: \
250         case OPT_V_ISSUER_CHECKS: \
251         case OPT_V_CRL_CHECK: \
252         case OPT_V_CRL_CHECK_ALL: \
253         case OPT_V_POLICY_CHECK: \
254         case OPT_V_EXPLICIT_POLICY: \
255         case OPT_V_INHIBIT_ANY: \
256         case OPT_V_INHIBIT_MAP: \
257         case OPT_V_X509_STRICT: \
258         case OPT_V_EXTENDED_CRL: \
259         case OPT_V_USE_DELTAS: \
260         case OPT_V_POLICY_PRINT: \
261         case OPT_V_CHECK_SS_SIG: \
262         case OPT_V_TRUSTED_FIRST: \
263         case OPT_V_SUITEB_128_ONLY: \
264         case OPT_V_SUITEB_128: \
265         case OPT_V_SUITEB_192: \
266         case OPT_V_PARTIAL_CHAIN: \
267         case OPT_V_NO_ALT_CHAINS: \
268         case OPT_V_NO_CHECK_TIME
269
270 /*
271  * Common "extended"? options.
272  */
273 # define OPT_X_ENUM \
274         OPT_X__FIRST=1000, \
275         OPT_X_KEY, OPT_X_CERT, OPT_X_CHAIN, OPT_X_CHAIN_BUILD, \
276         OPT_X_CERTFORM, OPT_X_KEYFORM, \
277         OPT_X__LAST
278
279 # define OPT_X_OPTIONS \
280         { "xkey", OPT_X_KEY, '<', "key for Extended certificates"}, \
281         { "xcert", OPT_X_CERT, '<', "cert for Extended certificates"}, \
282         { "xchain", OPT_X_CHAIN, '<', "chain for Extended certificates"}, \
283         { "xchain_build", OPT_X_CHAIN_BUILD, '-', \
284             "build certificate chain for the extended certificates"}, \
285         { "xcertform", OPT_X_CERTFORM, 'F', \
286             "format of Extended certificate (PEM or DER) PEM default " }, \
287         { "xkeyform", OPT_X_KEYFORM, 'F', \
288             "format of Exnteded certificate's key (PEM or DER) PEM default"}
289
290 # define OPT_X_CASES \
291         OPT_X__FIRST: case OPT_X__LAST: break; \
292         case OPT_X_KEY: \
293         case OPT_X_CERT: \
294         case OPT_X_CHAIN: \
295         case OPT_X_CHAIN_BUILD: \
296         case OPT_X_CERTFORM: \
297         case OPT_X_KEYFORM
298
299 /*
300  * Common SSL options.
301  * Any changes here must be coordinated with ../ssl/ssl_conf.c
302  */
303 # define OPT_S_ENUM \
304         OPT_S__FIRST=3000, \
305         OPT_S_NOSSL3, OPT_S_NOTLS1, OPT_S_NOTLS1_1, OPT_S_NOTLS1_2, \
306         OPT_S_BUGS, OPT_S_NO_COMP, OPT_S_NOTICKET, \
307         OPT_S_SERVERPREF, OPT_S_LEGACYRENEG, OPT_S_LEGACYCONN, \
308         OPT_S_ONRESUMP, OPT_S_NOLEGACYCONN, OPT_S_STRICT, OPT_S_SIGALGS, \
309         OPT_S_CLIENTSIGALGS, OPT_S_CURVES, OPT_S_NAMEDCURVE, OPT_S_CIPHER, \
310         OPT_S_DHPARAM, OPT_S_DEBUGBROKE, OPT_S_COMP, \
311         OPT_S__LAST
312
313 # define OPT_S_OPTIONS \
314         {"no_ssl3", OPT_S_NOSSL3, '-',"Just disable SSLv3" }, \
315         {"no_tls1", OPT_S_NOTLS1, '-', "Just disable TLSv1"}, \
316         {"no_tls1_1", OPT_S_NOTLS1_1, '-', "Just disable TLSv1.1" }, \
317         {"no_tls1_2", OPT_S_NOTLS1_2, '-', "Just disable TLSv1.2"}, \
318         {"bugs", OPT_S_BUGS, '-', "Turn on SSL bug compatibility"}, \
319         {"no_comp", OPT_S_NO_COMP, '-', "Disable SSL/TLS compression (default)" }, \
320         {"comp", OPT_S_COMP, '-', "Use SSL/TLS-level compression" }, \
321         {"no_ticket", OPT_S_NOTICKET, '-', \
322             "Disable use of TLS session tickets"}, \
323         {"serverpref", OPT_S_SERVERPREF, '-', "Use server's cipher preferences"}, \
324         {"legacy_renegotiation", OPT_S_LEGACYRENEG, '-', \
325             "Enable use of legacy renegotiation (dangerous)"}, \
326         {"legacy_server_connect", OPT_S_LEGACYCONN, '-', \
327             "Allow initial connection to servers that don't support RI"}, \
328         {"no_resumption_on_reneg", OPT_S_ONRESUMP, '-', \
329             "Disallow session resumption on renegotiation"}, \
330         {"no_legacy_server_connect", OPT_S_NOLEGACYCONN, '-', \
331             "Disallow initial connection to servers that don't support RI"}, \
332         {"strict", OPT_S_STRICT, '-', \
333             "Enforce strict certificate checks as per TLS standard"}, \
334         {"sigalgs", OPT_S_SIGALGS, 's', \
335             "Signature algorithms to support (colon-separated list)" }, \
336         {"client_sigalgs", OPT_S_CLIENTSIGALGS, 's', \
337             "Signature algorithms to support for client certificate" \
338             " authentication (colon-separated list)" }, \
339         {"curves", OPT_S_CURVES, 's', \
340             "Elliptic curves to advertise (colon-separated list)" }, \
341         {"named_curve", OPT_S_NAMEDCURVE, 's', \
342             "Elliptic curve used for ECDHE (server-side only)" }, \
343         {"cipher", OPT_S_CIPHER, 's', "Specify cipher list to be used"}, \
344         {"dhparam", OPT_S_DHPARAM, '<', \
345             "DH parameter file to use, in cert file if not specified"}, \
346         {"debug_broken_protocol", OPT_S_DEBUGBROKE, '-', \
347             "Perform all sorts of protocol violations for testing purposes"}
348
349 # define OPT_S_CASES \
350         OPT_S__FIRST: case OPT_S__LAST: break; \
351         case OPT_S_NOSSL3: \
352         case OPT_S_NOTLS1: \
353         case OPT_S_NOTLS1_1: \
354         case OPT_S_NOTLS1_2: \
355         case OPT_S_BUGS: \
356         case OPT_S_NO_COMP: \
357         case OPT_S_COMP: \
358         case OPT_S_NOTICKET: \
359         case OPT_S_SERVERPREF: \
360         case OPT_S_LEGACYRENEG: \
361         case OPT_S_LEGACYCONN: \
362         case OPT_S_ONRESUMP: \
363         case OPT_S_NOLEGACYCONN: \
364         case OPT_S_STRICT: \
365         case OPT_S_SIGALGS: \
366         case OPT_S_CLIENTSIGALGS: \
367         case OPT_S_CURVES: \
368         case OPT_S_NAMEDCURVE: \
369         case OPT_S_CIPHER: \
370         case OPT_S_DHPARAM: \
371         case OPT_S_DEBUGBROKE
372
373 /*
374  * Option parsing.
375  */
376 extern const char OPT_HELP_STR[];
377 extern const char OPT_MORE_STR[];
378 typedef struct options_st {
379     const char *name;
380     int retval;
381     /*
382      * value type: - no value (also the value zero), n number, p positive
383      * number, u unsigned, l long, s string, < input file, > output file,
384      * f any format, F der/pem format , E der/pem/engine format identifier.
385      * l, n and u include zero; p does not.
386      */
387     int valtype;
388     const char *helpstr;
389 } OPTIONS;
390
391 /*
392  * A string/int pairing; widely use for option value lookup, hence the
393  * name OPT_PAIR. But that name is misleading in s_cb.c, so we also use
394  * the "generic" name STRINT_PAIR.
395  */
396 typedef struct string_int_pair_st {
397     const char *name;
398     int retval;
399 } OPT_PAIR, STRINT_PAIR;
400
401 /* Flags to pass into opt_format; see FORMAT_xxx, below. */
402 # define OPT_FMT_PEMDER          (1L <<  1)
403 # define OPT_FMT_PKCS12          (1L <<  2)
404 # define OPT_FMT_SMIME           (1L <<  3)
405 # define OPT_FMT_ENGINE          (1L <<  4)
406 # define OPT_FMT_MSBLOB          (1L <<  5)
407 # define OPT_FMT_NETSCAPE        (1L <<  6)
408 # define OPT_FMT_NSS             (1L <<  7)
409 # define OPT_FMT_TEXT            (1L <<  8)
410 # define OPT_FMT_HTTP            (1L <<  9)
411 # define OPT_FMT_PVK             (1L << 10)
412 # define OPT_FMT_PDE     (OPT_FMT_PEMDER | OPT_FMT_ENGINE)
413 # define OPT_FMT_ANY     ( \
414         OPT_FMT_PEMDER | OPT_FMT_PKCS12 | OPT_FMT_SMIME | \
415         OPT_FMT_ENGINE | OPT_FMT_MSBLOB | OPT_FMT_NETSCAPE | \
416         OPT_FMT_NSS | OPT_FMT_TEXT | OPT_FMT_HTTP | OPT_FMT_PVK)
417
418 char *opt_progname(const char *argv0);
419 char *opt_getprog(void);
420 char *opt_init(int ac, char **av, const OPTIONS * o);
421 int opt_next();
422 int opt_format(const char *s, unsigned long flags, int *result);
423 int opt_int(const char *arg, int *result);
424 int opt_ulong(const char *arg, unsigned long *result);
425 int opt_long(const char *arg, long *result);
426 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L && \
427     defined(INTMAX_MAX) && defined(UINTMAX_MAX)
428 int opt_imax(const char *arg, intmax_t *result);
429 int opt_umax(const char *arg, uintmax_t *result);
430 #endif
431 int opt_pair(const char *arg, const OPT_PAIR * pairs, int *result);
432 int opt_cipher(const char *name, const EVP_CIPHER **cipherp);
433 int opt_md(const char *name, const EVP_MD **mdp);
434 char *opt_arg(void);
435 char *opt_flag(void);
436 char *opt_unknown(void);
437 char *opt_reset(void);
438 char **opt_rest(void);
439 int opt_num_rest(void);
440 int opt_verify(int i, X509_VERIFY_PARAM *vpm);
441 void opt_help(const OPTIONS * list);
442 int opt_format_error(const char *s, unsigned long flags);
443 int opt_next(void);
444
445 typedef struct args_st {
446     int size;
447     int argc;
448     char **argv;
449 } ARGS;
450
451 # define PW_MIN_LENGTH 4
452 typedef struct pw_cb_data {
453     const void *password;
454     const char *prompt_info;
455 } PW_CB_DATA;
456
457 int password_callback(char *buf, int bufsiz, int verify, PW_CB_DATA *cb_data);
458
459 int setup_ui_method(void);
460 void destroy_ui_method(void);
461
462 int chopup_args(ARGS *arg, char *buf);
463 # ifdef HEADER_X509_H
464 int dump_cert_text(BIO *out, X509 *x);
465 void print_name(BIO *out, const char *title, X509_NAME *nm,
466                 unsigned long lflags);
467 # endif
468 void print_bignum_var(BIO *, BIGNUM *, const char*, int, unsigned char *);
469 void print_array(BIO *, const char *, int, const unsigned char *);
470 int set_cert_ex(unsigned long *flags, const char *arg);
471 int set_name_ex(unsigned long *flags, const char *arg);
472 int set_ext_copy(int *copy_type, const char *arg);
473 int copy_extensions(X509 *x, X509_REQ *req, int copy_type);
474 int app_passwd(char *arg1, char *arg2, char **pass1, char **pass2);
475 int add_oid_section(CONF *conf);
476 X509 *load_cert(const char *file, int format,
477                 const char *pass, ENGINE *e, const char *cert_descrip);
478 X509_CRL *load_crl(const char *infile, int format);
479 int load_cert_crl_http(const char *url, X509 **pcert, X509_CRL **pcrl);
480 EVP_PKEY *load_key(const char *file, int format, int maybe_stdin,
481                    const char *pass, ENGINE *e, const char *key_descrip);
482 EVP_PKEY *load_pubkey(const char *file, int format, int maybe_stdin,
483                       const char *pass, ENGINE *e, const char *key_descrip);
484 int load_certs(const char *file, STACK_OF(X509) **certs, int format,
485                const char *pass, ENGINE *e, const char *cert_descrip);
486 int load_crls(const char *file, STACK_OF(X509_CRL) **crls, int format,
487               const char *pass, ENGINE *e, const char *cert_descrip);
488 X509_STORE *setup_verify(char *CAfile, char *CApath,
489                          int noCAfile, int noCApath);
490 int ctx_set_verify_locations(SSL_CTX *ctx, const char *CAfile,
491                              const char *CApath, int noCAfile, int noCApath);
492 # ifdef OPENSSL_NO_ENGINE
493 #  define setup_engine(engine, debug) NULL
494 # else
495 ENGINE *setup_engine(const char *engine, int debug);
496 # endif
497 # ifndef OPENSSL_NO_OCSP
498 OCSP_RESPONSE *process_responder(OCSP_REQUEST *req,
499                                  const char *host, const char *path,
500                                  const char *port, int use_ssl,
501                                  STACK_OF(CONF_VALUE) *headers,
502                                  int req_timeout);
503 # endif
504
505 /* Functions defined in ca.c and also used in ocsp.c */
506 int unpack_revinfo(ASN1_TIME **prevtm, int *preason, ASN1_OBJECT **phold,
507                    ASN1_GENERALIZEDTIME **pinvtm, const char *str);
508
509 # define DB_type         0
510 # define DB_exp_date     1
511 # define DB_rev_date     2
512 # define DB_serial       3      /* index - unique */
513 # define DB_file         4
514 # define DB_name         5      /* index - unique when active and not
515                                  * disabled */
516 # define DB_NUMBER       6
517
518 # define DB_TYPE_REV     'R'
519 # define DB_TYPE_EXP     'E'
520 # define DB_TYPE_VAL     'V'
521
522 typedef struct db_attr_st {
523     int unique_subject;
524 } DB_ATTR;
525 typedef struct ca_db_st {
526     DB_ATTR attributes;
527     TXT_DB *db;
528 } CA_DB;
529
530 void* app_malloc(int sz, const char *what);
531 BIGNUM *load_serial(char *serialfile, int create, ASN1_INTEGER **retai);
532 int save_serial(char *serialfile, char *suffix, BIGNUM *serial,
533                 ASN1_INTEGER **retai);
534 int rotate_serial(char *serialfile, char *new_suffix, char *old_suffix);
535 int rand_serial(BIGNUM *b, ASN1_INTEGER *ai);
536 CA_DB *load_index(char *dbfile, DB_ATTR *dbattr);
537 int index_index(CA_DB *db);
538 int save_index(const char *dbfile, const char *suffix, CA_DB *db);
539 int rotate_index(const char *dbfile, const char *new_suffix,
540                  const char *old_suffix);
541 void free_index(CA_DB *db);
542 # define index_name_cmp_noconst(a, b) \
543         index_name_cmp((const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, a), \
544         (const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, b))
545 int index_name_cmp(const OPENSSL_CSTRING *a, const OPENSSL_CSTRING *b);
546 int parse_yesno(const char *str, int def);
547
548 X509_NAME *parse_name(const char *str, long chtype, int multirdn);
549 int args_verify(char ***pargs, int *pargc,
550                 int *badarg, X509_VERIFY_PARAM **pm);
551 void policies_print(X509_STORE_CTX *ctx);
552 int bio_to_mem(unsigned char **out, int maxlen, BIO *in);
553 int pkey_ctrl_string(EVP_PKEY_CTX *ctx, const char *value);
554 int init_gen_str(EVP_PKEY_CTX **pctx,
555                  const char *algname, ENGINE *e, int do_param);
556 int do_X509_sign(X509 *x, EVP_PKEY *pkey, const EVP_MD *md,
557                  STACK_OF(OPENSSL_STRING) *sigopts);
558 int do_X509_REQ_sign(X509_REQ *x, EVP_PKEY *pkey, const EVP_MD *md,
559                      STACK_OF(OPENSSL_STRING) *sigopts);
560 int do_X509_CRL_sign(X509_CRL *x, EVP_PKEY *pkey, const EVP_MD *md,
561                      STACK_OF(OPENSSL_STRING) *sigopts);
562 # ifndef OPENSSL_NO_PSK
563 extern char *psk_key;
564 # endif
565 # ifndef OPENSSL_NO_JPAKE
566 void jpake_client_auth(BIO *out, BIO *conn, const char *secret);
567 void jpake_server_auth(BIO *out, BIO *conn, const char *secret);
568 # endif
569
570 unsigned char *next_protos_parse(unsigned short *outlen, const char *in);
571
572 void print_cert_checks(BIO *bio, X509 *x,
573                        const char *checkhost,
574                        const char *checkemail, const char *checkip);
575
576 void store_setup_crl_download(X509_STORE *st);
577
578 /* See OPT_FMT_xxx, above. */
579 /* On some platforms, it's important to distinguish between text and binary
580  * files.  On some, there might even be specific file formats for different
581  * contents.  The FORMAT_xxx macros are meant to express an intent with the
582  * file being read or created.
583  */
584 # define B_FORMAT_TEXT   0x8000
585 # define FORMAT_UNDEF    0
586 # define FORMAT_TEXT    (1 | B_FORMAT_TEXT)     /* Generic text */
587 # define FORMAT_BINARY   2                      /* Generic binary */
588 # define FORMAT_BASE64  (3 | B_FORMAT_TEXT)     /* Base64 */
589 # define FORMAT_ASN1     4                      /* ASN.1/DER */
590 # define FORMAT_PEM     (5 | B_FORMAT_TEXT)
591 # define FORMAT_PKCS12   6
592 # define FORMAT_SMIME   (7 | B_FORMAT_TEXT)
593 # define FORMAT_ENGINE   8                      /* Not really a file format */
594 # define FORMAT_PEMRSA  (9 | B_FORMAT_TEXT)     /* PEM RSAPubicKey format */
595 # define FORMAT_ASN1RSA  10                     /* DER RSAPubicKey format */
596 # define FORMAT_MSBLOB   11                     /* MS Key blob format */
597 # define FORMAT_PVK      12                     /* MS PVK file format */
598 # define FORMAT_HTTP     13                     /* Download using HTTP */
599 # define FORMAT_NSS      14                     /* NSS keylog format */
600
601 # define EXT_COPY_NONE   0
602 # define EXT_COPY_ADD    1
603 # define EXT_COPY_ALL    2
604
605 # define NETSCAPE_CERT_HDR       "certificate"
606
607 # define APP_PASS_LEN    1024
608
609 # define SERIAL_RAND_BITS        64
610
611 int app_hex(char);
612 int app_isdir(const char *);
613 int app_access(const char *, int flag);
614 int raw_read_stdin(void *, int);
615 int raw_write_stdout(const void *, int);
616
617 # define TM_START        0
618 # define TM_STOP         1
619 double app_tminterval(int stop, int usertime);
620
621 /* this is an accident waiting to happen (-Wshadow is your friend) */
622 extern int verify_depth;
623 extern int verify_quiet;
624 extern int verify_error;
625 extern int verify_return_error;
626
627 # include "progs.h"
628
629 #endif