apps/include/opt.h

   1 /*
   2  * Copyright 2018-2022 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9 #ifndef OSSL_APPS_OPT_H
  10 #define OSSL_APPS_OPT_H
  11
  12 #include <sys/types.h>
  13 #include <openssl/e_os2.h>
  14 #include <openssl/types.h>
  15 #include <stdarg.h>
  16
  17 #define OPT_COMMON OPT_ERR = -1, OPT_EOF = 0, OPT_HELP
  18
  19 /*
  20  * Common verification options.
  21  */
  22 # define OPT_V_ENUM \
  23         OPT_V__FIRST=2000, \
  24         OPT_V_POLICY, OPT_V_PURPOSE, OPT_V_VERIFY_NAME, OPT_V_VERIFY_DEPTH, \
  25         OPT_V_ATTIME, OPT_V_VERIFY_HOSTNAME, OPT_V_VERIFY_EMAIL, \
  26         OPT_V_VERIFY_IP, OPT_V_IGNORE_CRITICAL, OPT_V_ISSUER_CHECKS, \
  27         OPT_V_CRL_CHECK, OPT_V_CRL_CHECK_ALL, OPT_V_POLICY_CHECK, \
  28         OPT_V_EXPLICIT_POLICY, OPT_V_INHIBIT_ANY, OPT_V_INHIBIT_MAP, \
  29         OPT_V_X509_STRICT, OPT_V_EXTENDED_CRL, OPT_V_USE_DELTAS, \
  30         OPT_V_POLICY_PRINT, OPT_V_CHECK_SS_SIG, OPT_V_TRUSTED_FIRST, \
  31         OPT_V_SUITEB_128_ONLY, OPT_V_SUITEB_128, OPT_V_SUITEB_192, \
  32         OPT_V_PARTIAL_CHAIN, OPT_V_NO_ALT_CHAINS, OPT_V_NO_CHECK_TIME, \
  33         OPT_V_VERIFY_AUTH_LEVEL, OPT_V_ALLOW_PROXY_CERTS, \
  34         OPT_V__LAST
  35
  36 # define OPT_V_OPTIONS \
  37         OPT_SECTION("Validation"), \
  38         { "policy", OPT_V_POLICY, 's', "adds policy to the acceptable policy set"}, \
  39         { "purpose", OPT_V_PURPOSE, 's', \
  40             "certificate chain purpose"}, \
  41         { "verify_name", OPT_V_VERIFY_NAME, 's', "verification policy name"}, \
  42         { "verify_depth", OPT_V_VERIFY_DEPTH, 'n', \
  43             "chain depth limit" }, \
  44         { "auth_level", OPT_V_VERIFY_AUTH_LEVEL, 'n', \
  45             "chain authentication security level" }, \
  46         { "attime", OPT_V_ATTIME, 'M', "verification epoch time" }, \
  47         { "verify_hostname", OPT_V_VERIFY_HOSTNAME, 's', \
  48             "expected peer hostname" }, \
  49         { "verify_email", OPT_V_VERIFY_EMAIL, 's', \
  50             "expected peer email" }, \
  51         { "verify_ip", OPT_V_VERIFY_IP, 's', \
  52             "expected peer IP address" }, \
  53         { "ignore_critical", OPT_V_IGNORE_CRITICAL, '-', \
  54             "permit unhandled critical extensions"}, \
  55         { "issuer_checks", OPT_V_ISSUER_CHECKS, '-', "(deprecated)"}, \
  56         { "crl_check", OPT_V_CRL_CHECK, '-', "check leaf certificate revocation" }, \
  57         { "crl_check_all", OPT_V_CRL_CHECK_ALL, '-', "check full chain revocation" }, \
  58         { "policy_check", OPT_V_POLICY_CHECK, '-', "perform rfc5280 policy checks"}, \
  59         { "explicit_policy", OPT_V_EXPLICIT_POLICY, '-', \
  60             "set policy variable require-explicit-policy"}, \
  61         { "inhibit_any", OPT_V_INHIBIT_ANY, '-', \
  62             "set policy variable inhibit-any-policy"}, \
  63         { "inhibit_map", OPT_V_INHIBIT_MAP, '-', \
  64             "set policy variable inhibit-policy-mapping"}, \
  65         { "x509_strict", OPT_V_X509_STRICT, '-', \
  66             "disable certificate compatibility work-arounds"}, \
  67         { "extended_crl", OPT_V_EXTENDED_CRL, '-', \
  68             "enable extended CRL features"}, \
  69         { "use_deltas", OPT_V_USE_DELTAS, '-', \
  70             "use delta CRLs"}, \
  71         { "policy_print", OPT_V_POLICY_PRINT, '-', \
  72             "print policy processing diagnostics"}, \
  73         { "check_ss_sig", OPT_V_CHECK_SS_SIG, '-', \
  74             "check root CA self-signatures"}, \
  75         { "trusted_first", OPT_V_TRUSTED_FIRST, '-', \
  76             "search trust store first (default)" }, \
  77         { "suiteB_128_only", OPT_V_SUITEB_128_ONLY, '-', "Suite B 128-bit-only mode"}, \
  78         { "suiteB_128", OPT_V_SUITEB_128, '-', \
  79             "Suite B 128-bit mode allowing 192-bit algorithms"}, \
  80         { "suiteB_192", OPT_V_SUITEB_192, '-', "Suite B 192-bit-only mode" }, \
  81         { "partial_chain", OPT_V_PARTIAL_CHAIN, '-', \
  82             "accept chains anchored by intermediate trust-store CAs"}, \
  83         { "no_alt_chains", OPT_V_NO_ALT_CHAINS, '-', "(deprecated)" }, \
  84         { "no_check_time", OPT_V_NO_CHECK_TIME, '-', "ignore certificate validity time" }, \
  85         { "allow_proxy_certs", OPT_V_ALLOW_PROXY_CERTS, '-', "allow the use of proxy certificates" }
  86
  87 # define OPT_V_CASES \
  88         OPT_V__FIRST: case OPT_V__LAST: break; \
  89         case OPT_V_POLICY: \
  90         case OPT_V_PURPOSE: \
  91         case OPT_V_VERIFY_NAME: \
  92         case OPT_V_VERIFY_DEPTH: \
  93         case OPT_V_VERIFY_AUTH_LEVEL: \
  94         case OPT_V_ATTIME: \
  95         case OPT_V_VERIFY_HOSTNAME: \
  96         case OPT_V_VERIFY_EMAIL: \
  97         case OPT_V_VERIFY_IP: \
  98         case OPT_V_IGNORE_CRITICAL: \
  99         case OPT_V_ISSUER_CHECKS: \
 100         case OPT_V_CRL_CHECK: \
 101         case OPT_V_CRL_CHECK_ALL: \
 102         case OPT_V_POLICY_CHECK: \
 103         case OPT_V_EXPLICIT_POLICY: \
 104         case OPT_V_INHIBIT_ANY: \
 105         case OPT_V_INHIBIT_MAP: \
 106         case OPT_V_X509_STRICT: \
 107         case OPT_V_EXTENDED_CRL: \
 108         case OPT_V_USE_DELTAS: \
 109         case OPT_V_POLICY_PRINT: \
 110         case OPT_V_CHECK_SS_SIG: \
 111         case OPT_V_TRUSTED_FIRST: \
 112         case OPT_V_SUITEB_128_ONLY: \
 113         case OPT_V_SUITEB_128: \
 114         case OPT_V_SUITEB_192: \
 115         case OPT_V_PARTIAL_CHAIN: \
 116         case OPT_V_NO_ALT_CHAINS: \
 117         case OPT_V_NO_CHECK_TIME: \
 118         case OPT_V_ALLOW_PROXY_CERTS
 119
 120 /*
 121  * Common "extended validation" options.
 122  */
 123 # define OPT_X_ENUM \
 124         OPT_X__FIRST=1000, \
 125         OPT_X_KEY, OPT_X_CERT, OPT_X_CHAIN, OPT_X_CHAIN_BUILD, \
 126         OPT_X_CERTFORM, OPT_X_KEYFORM, \
 127         OPT_X__LAST
 128
 129 # define OPT_X_OPTIONS \
 130         OPT_SECTION("Extended certificate"), \
 131         { "xkey", OPT_X_KEY, '<', "key for Extended certificates"}, \
 132         { "xcert", OPT_X_CERT, '<', "cert for Extended certificates"}, \
 133         { "xchain", OPT_X_CHAIN, '<', "chain for Extended certificates"}, \
 134         { "xchain_build", OPT_X_CHAIN_BUILD, '-', \
 135             "build certificate chain for the extended certificates"}, \
 136         { "xcertform", OPT_X_CERTFORM, 'F', \
 137             "format of Extended certificate (PEM/DER/P12); has no effect" }, \
 138         { "xkeyform", OPT_X_KEYFORM, 'F', \
 139             "format of Extended certificate's key (DER/PEM/P12); has no effect"}
 140
 141 # define OPT_X_CASES \
 142         OPT_X__FIRST: case OPT_X__LAST: break; \
 143         case OPT_X_KEY: \
 144         case OPT_X_CERT: \
 145         case OPT_X_CHAIN: \
 146         case OPT_X_CHAIN_BUILD: \
 147         case OPT_X_CERTFORM: \
 148         case OPT_X_KEYFORM
 149
 150 /*
 151  * Common SSL options.
 152  * Any changes here must be coordinated with ../ssl/ssl_conf.c
 153  */
 154 # define OPT_S_ENUM \
 155         OPT_S__FIRST=3000, \
 156         OPT_S_NOSSL3, OPT_S_NOTLS1, OPT_S_NOTLS1_1, OPT_S_NOTLS1_2, \
 157         OPT_S_NOTLS1_3, OPT_S_BUGS, OPT_S_NO_COMP, OPT_S_NOTICKET, \
 158         OPT_S_SERVERPREF, OPT_S_LEGACYRENEG, OPT_S_CLIENTRENEG, \
 159         OPT_S_LEGACYCONN, \
 160         OPT_S_ONRESUMP, OPT_S_NOLEGACYCONN, OPT_S_ALLOW_NO_DHE_KEX, \
 161         OPT_S_PRIORITIZE_CHACHA, \
 162         OPT_S_STRICT, OPT_S_SIGALGS, OPT_S_CLIENTSIGALGS, OPT_S_GROUPS, \
 163         OPT_S_CURVES, OPT_S_NAMEDCURVE, OPT_S_CIPHER, OPT_S_CIPHERSUITES, \
 164         OPT_S_RECORD_PADDING, OPT_S_DEBUGBROKE, OPT_S_COMP, \
 165         OPT_S_MINPROTO, OPT_S_MAXPROTO, \
 166         OPT_S_NO_RENEGOTIATION, OPT_S_NO_MIDDLEBOX, OPT_S_NO_ETM, \
 167         OPT_S_NO_EMS, OPT_S__LAST
 168
 169 # define OPT_S_OPTIONS \
 170         OPT_SECTION("TLS/SSL"), \
 171         {"no_ssl3", OPT_S_NOSSL3, '-',"Just disable SSLv3" }, \
 172         {"no_tls1", OPT_S_NOTLS1, '-', "Just disable TLSv1"}, \
 173         {"no_tls1_1", OPT_S_NOTLS1_1, '-', "Just disable TLSv1.1" }, \
 174         {"no_tls1_2", OPT_S_NOTLS1_2, '-', "Just disable TLSv1.2"}, \
 175         {"no_tls1_3", OPT_S_NOTLS1_3, '-', "Just disable TLSv1.3"}, \
 176         {"bugs", OPT_S_BUGS, '-', "Turn on SSL bug compatibility"}, \
 177         {"no_comp", OPT_S_NO_COMP, '-', "Disable SSL/TLS compression (default)" }, \
 178         {"comp", OPT_S_COMP, '-', "Use SSL/TLS-level compression" }, \
 179         {"no_ticket", OPT_S_NOTICKET, '-', \
 180             "Disable use of TLS session tickets"}, \
 181         {"serverpref", OPT_S_SERVERPREF, '-', "Use server's cipher preferences"}, \
 182         {"legacy_renegotiation", OPT_S_LEGACYRENEG, '-', \
 183             "Enable use of legacy renegotiation (dangerous)"}, \
 184         {"client_renegotiation", OPT_S_CLIENTRENEG, '-', \
 185             "Allow client-initiated renegotiation" }, \
 186         {"no_renegotiation", OPT_S_NO_RENEGOTIATION, '-', \
 187             "Disable all renegotiation."}, \
 188         {"legacy_server_connect", OPT_S_LEGACYCONN, '-', \
 189             "Allow initial connection to servers that don't support RI"}, \
 190         {"no_resumption_on_reneg", OPT_S_ONRESUMP, '-', \
 191             "Disallow session resumption on renegotiation"}, \
 192         {"no_legacy_server_connect", OPT_S_NOLEGACYCONN, '-', \
 193             "Disallow initial connection to servers that don't support RI"}, \
 194         {"allow_no_dhe_kex", OPT_S_ALLOW_NO_DHE_KEX, '-', \
 195             "In TLSv1.3 allow non-(ec)dhe based key exchange on resumption"}, \
 196         {"prioritize_chacha", OPT_S_PRIORITIZE_CHACHA, '-', \
 197             "Prioritize ChaCha ciphers when preferred by clients"}, \
 198         {"strict", OPT_S_STRICT, '-', \
 199             "Enforce strict certificate checks as per TLS standard"}, \
 200         {"sigalgs", OPT_S_SIGALGS, 's', \
 201             "Signature algorithms to support (colon-separated list)" }, \
 202         {"client_sigalgs", OPT_S_CLIENTSIGALGS, 's', \
 203             "Signature algorithms to support for client certificate" \
 204             " authentication (colon-separated list)" }, \
 205         {"groups", OPT_S_GROUPS, 's', \
 206             "Groups to advertise (colon-separated list)" }, \
 207         {"curves", OPT_S_CURVES, 's', \
 208             "Groups to advertise (colon-separated list)" }, \
 209         {"named_curve", OPT_S_NAMEDCURVE, 's', \
 210             "Elliptic curve used for ECDHE (server-side only)" }, \
 211         {"cipher", OPT_S_CIPHER, 's', "Specify TLSv1.2 and below cipher list to be used"}, \
 212         {"ciphersuites", OPT_S_CIPHERSUITES, 's', "Specify TLSv1.3 ciphersuites to be used"}, \
 213         {"min_protocol", OPT_S_MINPROTO, 's', "Specify the minimum protocol version to be used"}, \
 214         {"max_protocol", OPT_S_MAXPROTO, 's', "Specify the maximum protocol version to be used"}, \
 215         {"record_padding", OPT_S_RECORD_PADDING, 's', \
 216             "Block size to pad TLS 1.3 records to."}, \
 217         {"debug_broken_protocol", OPT_S_DEBUGBROKE, '-', \
 218             "Perform all sorts of protocol violations for testing purposes"}, \
 219         {"no_middlebox", OPT_S_NO_MIDDLEBOX, '-', \
 220             "Disable TLSv1.3 middlebox compat mode" }, \
 221         {"no_etm", OPT_S_NO_ETM, '-', \
 222             "Disable Encrypt-then-Mac extension"}, \
 223         {"no_ems", OPT_S_NO_EMS, '-', \
 224             "Disable Extended master secret extension"}
 225
 226 # define OPT_S_CASES \
 227         OPT_S__FIRST: case OPT_S__LAST: break; \
 228         case OPT_S_NOSSL3: \
 229         case OPT_S_NOTLS1: \
 230         case OPT_S_NOTLS1_1: \
 231         case OPT_S_NOTLS1_2: \
 232         case OPT_S_NOTLS1_3: \
 233         case OPT_S_BUGS: \
 234         case OPT_S_NO_COMP: \
 235         case OPT_S_COMP: \
 236         case OPT_S_NOTICKET: \
 237         case OPT_S_SERVERPREF: \
 238         case OPT_S_LEGACYRENEG: \
 239         case OPT_S_CLIENTRENEG: \
 240         case OPT_S_LEGACYCONN: \
 241         case OPT_S_ONRESUMP: \
 242         case OPT_S_NOLEGACYCONN: \
 243         case OPT_S_ALLOW_NO_DHE_KEX: \
 244         case OPT_S_PRIORITIZE_CHACHA: \
 245         case OPT_S_STRICT: \
 246         case OPT_S_SIGALGS: \
 247         case OPT_S_CLIENTSIGALGS: \
 248         case OPT_S_GROUPS: \
 249         case OPT_S_CURVES: \
 250         case OPT_S_NAMEDCURVE: \
 251         case OPT_S_CIPHER: \
 252         case OPT_S_CIPHERSUITES: \
 253         case OPT_S_RECORD_PADDING: \
 254         case OPT_S_NO_RENEGOTIATION: \
 255         case OPT_S_MINPROTO: \
 256         case OPT_S_MAXPROTO: \
 257         case OPT_S_DEBUGBROKE: \
 258         case OPT_S_NO_MIDDLEBOX: \
 259         case OPT_S_NO_ETM: \
 260         case OPT_S_NO_EMS
 261
 262 #define IS_NO_PROT_FLAG(o) \
 263  (o == OPT_S_NOSSL3 || o == OPT_S_NOTLS1 || o == OPT_S_NOTLS1_1 \
 264   || o == OPT_S_NOTLS1_2 || o == OPT_S_NOTLS1_3)
 265
 266 /*
 267  * Random state options.
 268  */
 269 # define OPT_R_ENUM \
 270         OPT_R__FIRST=1500, OPT_R_RAND, OPT_R_WRITERAND, OPT_R__LAST
 271
 272 # define OPT_R_OPTIONS \
 273     OPT_SECTION("Random state"), \
 274     {"rand", OPT_R_RAND, 's', "Load the given file(s) into the random number generator"}, \
 275     {"writerand", OPT_R_WRITERAND, '>', "Write random data to the specified file"}
 276
 277 # define OPT_R_CASES \
 278         OPT_R__FIRST: case OPT_R__LAST: break; \
 279         case OPT_R_RAND: case OPT_R_WRITERAND
 280
 281 /*
 282  * Provider options.
 283  */
 284 # define OPT_PROV_ENUM \
 285         OPT_PROV__FIRST=1600, \
 286         OPT_PROV_PROVIDER, OPT_PROV_PROVIDER_PATH, OPT_PROV_PROPQUERY, \
 287         OPT_PROV__LAST
 288
 289 # define OPT_CONFIG_OPTION \
 290         { "config", OPT_CONFIG, '<', "Load a configuration file (this may load modules)" }
 291
 292 # define OPT_PROV_OPTIONS \
 293         OPT_SECTION("Provider"), \
 294         { "provider-path", OPT_PROV_PROVIDER_PATH, 's', "Provider load path (must be before 'provider' argument if required)" }, \
 295         { "provider", OPT_PROV_PROVIDER, 's', "Provider to load (can be specified multiple times)" }, \
 296         { "propquery", OPT_PROV_PROPQUERY, 's', "Property query used when fetching algorithms" }
 297
 298 # define OPT_PROV_CASES \
 299         OPT_PROV__FIRST: case OPT_PROV__LAST: break; \
 300         case OPT_PROV_PROVIDER: \
 301         case OPT_PROV_PROVIDER_PATH: \
 302         case OPT_PROV_PROPQUERY
 303
 304 /*
 305  * Option parsing.
 306  */
 307 extern const char OPT_HELP_STR[];
 308 extern const char OPT_MORE_STR[];
 309 extern const char OPT_SECTION_STR[];
 310 extern const char OPT_PARAM_STR[];
 311
 312 typedef struct options_st {
 313     const char *name;
 314     int retval;
 315     /*
 316      * value type: - no value (also the value zero), n number, p positive
 317      * number, u unsigned, l long, s string, < input file, > output file,
 318      * f any format, F der/pem format, E der/pem/engine format identifier.
 319      * l, n and u include zero; p does not.
 320      */
 321     int valtype;
 322     const char *helpstr;
 323 } OPTIONS;
 324 /* Special retval values: */
 325 #define OPT_PARAM 0 /* same as OPT_EOF usually defined in apps */
 326 #define OPT_DUP -2 /* marks duplicate occurrence of option in help output */
 327
 328 /*
 329  * A string/int pairing; widely use for option value lookup, hence the
 330  * name OPT_PAIR. But that name is misleading in s_cb.c, so we also use
 331  * the "generic" name STRINT_PAIR.
 332  */
 333 typedef struct string_int_pair_st {
 334     const char *name;
 335     int retval;
 336 } OPT_PAIR, STRINT_PAIR;
 337
 338 /* Flags to pass into opt_format; see FORMAT_xxx, below. */
 339 # define OPT_FMT_PEMDER          (1L <<  1)
 340 # define OPT_FMT_PKCS12          (1L <<  2)
 341 # define OPT_FMT_SMIME           (1L <<  3)
 342 # define OPT_FMT_ENGINE          (1L <<  4)
 343 # define OPT_FMT_MSBLOB          (1L <<  5)
 344 /* (1L <<  6) was OPT_FMT_NETSCAPE, but wasn't used */
 345 # define OPT_FMT_NSS             (1L <<  7)
 346 # define OPT_FMT_TEXT            (1L <<  8)
 347 # define OPT_FMT_HTTP            (1L <<  9)
 348 # define OPT_FMT_PVK             (1L << 10)
 349 # define OPT_FMT_PDE     (OPT_FMT_PEMDER | OPT_FMT_ENGINE)
 350 # define OPT_FMT_PDS     (OPT_FMT_PEMDER | OPT_FMT_SMIME)
 351 # define OPT_FMT_ANY     ( \
 352         OPT_FMT_PEMDER | OPT_FMT_PKCS12 | OPT_FMT_SMIME | \
 353         OPT_FMT_ENGINE | OPT_FMT_MSBLOB | OPT_FMT_NSS   | \
 354         OPT_FMT_TEXT   | OPT_FMT_HTTP   | OPT_FMT_PVK)
 355
 356 /* Divide options into sections when displaying usage */
 357 #define OPT_SECTION(sec) { OPT_SECTION_STR, 1, '-', sec " options:\n" }
 358 #define OPT_PARAMETERS() { OPT_PARAM_STR, 1, '-', "Parameters:\n" }
 359
 360 const char *opt_path_end(const char *filename);
 361 char *opt_init(int ac, char **av, const OPTIONS * o);
 362 char *opt_progname(const char *argv0);
 363 char *opt_appname(const char *argv0);
 364 char *opt_getprog(void);
 365 void opt_help(const OPTIONS * list);
 366
 367 void opt_begin(void);
 368 int opt_next(void);
 369 char *opt_flag(void);
 370 char *opt_arg(void);
 371 char *opt_unknown(void);
 372 void reset_unknown(void);
 373 int opt_cipher(const char *name, EVP_CIPHER **cipherp);
 374 int opt_cipher_any(const char *name, EVP_CIPHER **cipherp);
 375 int opt_cipher_silent(const char *name, EVP_CIPHER **cipherp);
 376 int opt_check_md(const char *name);
 377 int opt_md(const char *name, EVP_MD **mdp);
 378 int opt_md_silent(const char *name, EVP_MD **mdp);
 379
 380 int opt_int(const char *arg, int *result);
 381 void opt_set_unknown_name(const char *name);
 382 int opt_int_arg(void);
 383 int opt_long(const char *arg, long *result);
 384 int opt_ulong(const char *arg, unsigned long *result);
 385 int opt_intmax(const char *arg, ossl_intmax_t *result);
 386 int opt_uintmax(const char *arg, ossl_uintmax_t *result);
 387
 388 int opt_isdir(const char *name);
 389 int opt_format(const char *s, unsigned long flags, int *result);
 390 void print_format_error(int format, unsigned long flags);
 391 int opt_printf_stderr(const char *fmt, ...);
 392 int opt_string(const char *name, const char **options);
 393 int opt_pair(const char *arg, const OPT_PAIR * pairs, int *result);
 394
 395 int opt_verify(int i, X509_VERIFY_PARAM *vpm);
 396 int opt_rand(int i);
 397 int opt_provider(int i);
 398 int opt_provider_option_given(void);
 399
 400 char **opt_rest(void);
 401 int opt_num_rest(void);
 402 int opt_check_rest_arg(const char *expected);
 403
 404 /* Returns non-zero if legacy paths are still available */
 405 int opt_legacy_okay(void);
 406
 407
 408 #endif /* OSSL_APPS_OPT_H */