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