apps/include/apps.h

   1 /*
   2  * Copyright 1995-2021 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
  10 #ifndef OSSL_APPS_H
  11 # define OSSL_APPS_H
  12
  13 # include "e_os.h" /* struct timeval for DTLS */
  14 # include "internal/common.h" /* for HAS_PREFIX */
  15 # include "internal/nelem.h"
  16 # include "internal/sockets.h" /* for openssl_fdset() */
  17 # include <assert.h>
  18
  19 # include <stdarg.h>
  20 # include <sys/types.h>
  21 # ifndef OPENSSL_NO_POSIX_IO
  22 #  include <sys/stat.h>
  23 #  include <fcntl.h>
  24 # endif
  25
  26 # include <openssl/e_os2.h>
  27 # include <openssl/types.h>
  28 # include <openssl/bio.h>
  29 # include <openssl/x509.h>
  30 # include <openssl/conf.h>
  31 # include <openssl/txt_db.h>
  32 # include <openssl/engine.h>
  33 # include <openssl/ocsp.h>
  34 # include <openssl/http.h>
  35 # include <signal.h>
  36 # include "apps_ui.h"
  37 # include "opt.h"
  38 # include "fmt.h"
  39 # include "platform.h"
  40 # include "engine_loader.h"
  41 # include "app_libctx.h"
  42
  43 /*
  44  * quick macro when you need to pass an unsigned char instead of a char.
  45  * this is true for some implementations of the is*() functions, for
  46  * example.
  47  */
  48 # define _UC(c) ((unsigned char)(c))
  49
  50 void app_RAND_load_conf(CONF *c, const char *section);
  51 int app_RAND_write(void);
  52 int app_RAND_load(void);
  53
  54 extern char *default_config_file; /* may be "" */
  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 extern BIO_ADDR *ourpeer;
  61
  62 BIO *dup_bio_in(int format);
  63 BIO *dup_bio_out(int format);
  64 BIO *dup_bio_err(int format);
  65 BIO *bio_open_owner(const char *filename, int format, int private);
  66 BIO *bio_open_default(const char *filename, char mode, int format);
  67 BIO *bio_open_default_quiet(const char *filename, char mode, int format);
  68 CONF *app_load_config_bio(BIO *in, const char *filename);
  69 #define app_load_config(filename) app_load_config_internal(filename, 0)
  70 #define app_load_config_quiet(filename) app_load_config_internal(filename, 1)
  71 CONF *app_load_config_internal(const char *filename, int quiet);
  72 CONF *app_load_config_verbose(const char *filename, int verbose);
  73 int app_load_modules(const CONF *config);
  74 CONF *app_load_config_modules(const char *configfile);
  75 void unbuffer(FILE *fp);
  76 void wait_for_async(SSL *s);
  77 # if defined(OPENSSL_SYS_MSDOS)
  78 int has_stdin_waiting(void);
  79 # endif
  80
  81 void corrupt_signature(const ASN1_STRING *signature);
  82 int set_cert_times(X509 *x, const char *startdate, const char *enddate,
  83                    int days);
  84 int set_crl_lastupdate(X509_CRL *crl, const char *lastupdate);
  85 int set_crl_nextupdate(X509_CRL *crl, const char *nextupdate,
  86                        long days, long hours, long secs);
  87
  88 typedef struct args_st {
  89     int size;
  90     int argc;
  91     char **argv;
  92 } ARGS;
  93
  94 /* We need both wrap and the "real" function because libcrypto uses both. */
  95 int wrap_password_callback(char *buf, int bufsiz, int verify, void *cb_data);
  96
  97 /* progress callback for dsaparam, dhparam, req, genpkey, etc. */
  98 int progress_cb(EVP_PKEY_CTX *ctx);
  99
 100 int chopup_args(ARGS *arg, char *buf);
 101 void dump_cert_text(BIO *out, X509 *x);
 102 void print_name(BIO *out, const char *title, const X509_NAME *nm);
 103 void print_bignum_var(BIO *, const BIGNUM *, const char*,
 104                       int, unsigned char *);
 105 void print_array(BIO *, const char *, int, const unsigned char *);
 106 int set_nameopt(const char *arg);
 107 unsigned long get_nameopt(void);
 108 int set_dateopt(unsigned long *dateopt, const char *arg);
 109 int set_cert_ex(unsigned long *flags, const char *arg);
 110 int set_name_ex(unsigned long *flags, const char *arg);
 111 int set_ext_copy(int *copy_type, const char *arg);
 112 int copy_extensions(X509 *x, X509_REQ *req, int copy_type);
 113 char *get_passwd(const char *pass, const char *desc);
 114 int app_passwd(const char *arg1, const char *arg2, char **pass1, char **pass2);
 115 int add_oid_section(CONF *conf);
 116 X509_REQ *load_csr(const char *file, int format, const char *desc);
 117 X509 *load_cert_pass(const char *uri, int format, int maybe_stdin,
 118                      const char *pass, const char *desc);
 119 #define load_cert(uri, format, desc) load_cert_pass(uri, format, 1, NULL, desc)
 120 X509_CRL *load_crl(const char *uri, int format, int maybe_stdin,
 121                    const char *desc);
 122 void cleanse(char *str);
 123 void clear_free(char *str);
 124 EVP_PKEY *load_key(const char *uri, int format, int maybe_stdin,
 125                    const char *pass, ENGINE *e, const char *desc);
 126 EVP_PKEY *load_pubkey(const char *uri, int format, int maybe_stdin,
 127                       const char *pass, ENGINE *e, const char *desc);
 128 EVP_PKEY *load_keyparams(const char *uri, int format, int maybe_stdin,
 129                          const char *keytype, const char *desc);
 130 EVP_PKEY *load_keyparams_suppress(const char *uri, int format, int maybe_stdin,
 131                                   const char *keytype, const char *desc,
 132                                   int suppress_decode_errors);
 133 char *next_item(char *opt); /* in list separated by comma and/or space */
 134 int load_cert_certs(const char *uri,
 135                     X509 **pcert, STACK_OF(X509) **pcerts,
 136                     int exclude_http, const char *pass, const char *desc,
 137                     X509_VERIFY_PARAM *vpm);
 138 STACK_OF(X509) *load_certs_multifile(char *files, const char *pass,
 139                                      const char *desc, X509_VERIFY_PARAM *vpm);
 140 X509_STORE *load_certstore(char *input, const char *pass, const char *desc,
 141                            X509_VERIFY_PARAM *vpm);
 142 int load_certs(const char *uri, int maybe_stdin, STACK_OF(X509) **certs,
 143                const char *pass, const char *desc);
 144 int load_crls(const char *uri, STACK_OF(X509_CRL) **crls,
 145               const char *pass, const char *desc);
 146 int load_key_certs_crls(const char *uri, int format, int maybe_stdin,
 147                         const char *pass, const char *desc,
 148                         EVP_PKEY **ppkey, EVP_PKEY **ppubkey,
 149                         EVP_PKEY **pparams,
 150                         X509 **pcert, STACK_OF(X509) **pcerts,
 151                         X509_CRL **pcrl, STACK_OF(X509_CRL) **pcrls);
 152 int load_key_cert_crl(const char *uri, int format, int maybe_stdin,
 153                       const char *pass, const char *desc,
 154                       EVP_PKEY **ppkey, EVP_PKEY **ppubkey,
 155                       X509 **pcert, X509_CRL **pcrl);
 156 X509_STORE *setup_verify(const char *CAfile, int noCAfile,
 157                          const char *CApath, int noCApath,
 158                          const char *CAstore, int noCAstore);
 159 __owur int ctx_set_verify_locations(SSL_CTX *ctx,
 160                                     const char *CAfile, int noCAfile,
 161                                     const char *CApath, int noCApath,
 162                                     const char *CAstore, int noCAstore);
 163
 164 # ifndef OPENSSL_NO_CT
 165
 166 /*
 167  * Sets the file to load the Certificate Transparency log list from.
 168  * If path is NULL, loads from the default file path.
 169  * Returns 1 on success, 0 otherwise.
 170  */
 171 __owur int ctx_set_ctlog_list_file(SSL_CTX *ctx, const char *path);
 172
 173 # endif
 174
 175 ENGINE *setup_engine_methods(const char *id, unsigned int methods, int debug);
 176 # define setup_engine(e, debug) setup_engine_methods(e, (unsigned int)-1, debug)
 177 void release_engine(ENGINE *e);
 178 int init_engine(ENGINE *e);
 179 int finish_engine(ENGINE *e);
 180 char *make_engine_uri(ENGINE *e, const char *key_id, const char *desc);
 181
 182 int get_legacy_pkey_id(OSSL_LIB_CTX *libctx, const char *algname, ENGINE *e);
 183 const EVP_MD *get_digest_from_engine(const char *name);
 184 const EVP_CIPHER *get_cipher_from_engine(const char *name);
 185
 186 # ifndef OPENSSL_NO_OCSP
 187 OCSP_RESPONSE *process_responder(OCSP_REQUEST *req, const char *host,
 188                                  const char *port, const char *path,
 189                                  const char *proxy, const char *no_proxy,
 190                                  int use_ssl, STACK_OF(CONF_VALUE) *headers,
 191                                  int req_timeout);
 192 # endif
 193
 194 /* Functions defined in ca.c and also used in ocsp.c */
 195 int unpack_revinfo(ASN1_TIME **prevtm, int *preason, ASN1_OBJECT **phold,
 196                    ASN1_GENERALIZEDTIME **pinvtm, const char *str);
 197
 198 # define DB_type         0
 199 # define DB_exp_date     1
 200 # define DB_rev_date     2
 201 # define DB_serial       3      /* index - unique */
 202 # define DB_file         4
 203 # define DB_name         5      /* index - unique when active and not
 204                                  * disabled */
 205 # define DB_NUMBER       6
 206
 207 # define DB_TYPE_REV     'R'    /* Revoked  */
 208 # define DB_TYPE_EXP     'E'    /* Expired  */
 209 # define DB_TYPE_VAL     'V'    /* Valid ; inserted with: ca ... -valid */
 210 # define DB_TYPE_SUSP    'S'    /* Suspended  */
 211
 212 typedef struct db_attr_st {
 213     int unique_subject;
 214 } DB_ATTR;
 215 typedef struct ca_db_st {
 216     DB_ATTR attributes;
 217     TXT_DB *db;
 218     char *dbfname;
 219 # ifndef OPENSSL_NO_POSIX_IO
 220     struct stat dbst;
 221 # endif
 222 } CA_DB;
 223
 224 void app_bail_out(char *fmt, ...);
 225 void *app_malloc(size_t sz, const char *what);
 226 BIGNUM *load_serial(const char *serialfile, int create, ASN1_INTEGER **retai);
 227 int save_serial(const char *serialfile, const char *suffix, const BIGNUM *serial,
 228                 ASN1_INTEGER **retai);
 229 int rotate_serial(const char *serialfile, const char *new_suffix,
 230                   const char *old_suffix);
 231 int rand_serial(BIGNUM *b, ASN1_INTEGER *ai);
 232 CA_DB *load_index(const char *dbfile, DB_ATTR *dbattr);
 233 int index_index(CA_DB *db);
 234 int save_index(const char *dbfile, const char *suffix, CA_DB *db);
 235 int rotate_index(const char *dbfile, const char *new_suffix,
 236                  const char *old_suffix);
 237 void free_index(CA_DB *db);
 238 # define index_name_cmp_noconst(a, b) \
 239         index_name_cmp((const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, a), \
 240         (const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, b))
 241 int index_name_cmp(const OPENSSL_CSTRING *a, const OPENSSL_CSTRING *b);
 242 int parse_yesno(const char *str, int def);
 243
 244 X509_NAME *parse_name(const char *str, int chtype, int multirdn,
 245                       const char *desc);
 246 void policies_print(X509_STORE_CTX *ctx);
 247 int bio_to_mem(unsigned char **out, int maxlen, BIO *in);
 248 int pkey_ctrl_string(EVP_PKEY_CTX *ctx, const char *value);
 249 int x509_ctrl_string(X509 *x, const char *value);
 250 int x509_req_ctrl_string(X509_REQ *x, const char *value);
 251 int init_gen_str(EVP_PKEY_CTX **pctx,
 252                  const char *algname, ENGINE *e, int do_param,
 253                  OSSL_LIB_CTX *libctx, const char *propq);
 254 int cert_matches_key(const X509 *cert, const EVP_PKEY *pkey);
 255 int do_X509_sign(X509 *x, EVP_PKEY *pkey, const char *md,
 256                  STACK_OF(OPENSSL_STRING) *sigopts, X509V3_CTX *ext_ctx);
 257 int do_X509_verify(X509 *x, EVP_PKEY *pkey, STACK_OF(OPENSSL_STRING) *vfyopts);
 258 int do_X509_REQ_sign(X509_REQ *x, EVP_PKEY *pkey, const char *md,
 259                      STACK_OF(OPENSSL_STRING) *sigopts);
 260 int do_X509_REQ_verify(X509_REQ *x, EVP_PKEY *pkey,
 261                        STACK_OF(OPENSSL_STRING) *vfyopts);
 262 int do_X509_CRL_sign(X509_CRL *x, EVP_PKEY *pkey, const char *md,
 263                      STACK_OF(OPENSSL_STRING) *sigopts);
 264
 265 extern char *psk_key;
 266
 267
 268 unsigned char *next_protos_parse(size_t *outlen, const char *in);
 269
 270 int check_cert_attributes(BIO *bio, X509 *x,
 271                        const char *checkhost,
 272                        const char *checkemail, const char *checkip, int print);
 273
 274 void store_setup_crl_download(X509_STORE *st);
 275
 276 typedef struct app_http_tls_info_st {
 277     const char *server;
 278     const char *port;
 279     int use_proxy;
 280     long timeout;
 281     SSL_CTX *ssl_ctx;
 282 } APP_HTTP_TLS_INFO;
 283 BIO *app_http_tls_cb(BIO *hbio, /* APP_HTTP_TLS_INFO */ void *arg,
 284                      int connect, int detail);
 285 void APP_HTTP_TLS_INFO_free(APP_HTTP_TLS_INFO *info);
 286 # ifndef OPENSSL_NO_SOCK
 287 ASN1_VALUE *app_http_get_asn1(const char *url, const char *proxy,
 288                               const char *no_proxy, SSL_CTX *ssl_ctx,
 289                               const STACK_OF(CONF_VALUE) *headers,
 290                               long timeout, const char *expected_content_type,
 291                               const ASN1_ITEM *it);
 292 ASN1_VALUE *app_http_post_asn1(const char *host, const char *port,
 293                                const char *path, const char *proxy,
 294                                const char *no_proxy, SSL_CTX *ctx,
 295                                const STACK_OF(CONF_VALUE) *headers,
 296                                const char *content_type,
 297                                ASN1_VALUE *req, const ASN1_ITEM *req_it,
 298                                const char *expected_content_type,
 299                                long timeout, const ASN1_ITEM *rsp_it);
 300 # endif
 301
 302 # define EXT_COPY_NONE   0
 303 # define EXT_COPY_ADD    1
 304 # define EXT_COPY_ALL    2
 305
 306 # define NETSCAPE_CERT_HDR       "certificate"
 307
 308 # define APP_PASS_LEN    1024
 309
 310 /*
 311  * IETF RFC 5280 says serial number must be <= 20 bytes. Use 159 bits
 312  * so that the first bit will never be one, so that the DER encoding
 313  * rules won't force a leading octet.
 314  */
 315 # define SERIAL_RAND_BITS        159
 316
 317 int app_isdir(const char *);
 318 int app_access(const char *, int flag);
 319 int fileno_stdin(void);
 320 int fileno_stdout(void);
 321 int raw_read_stdin(void *, int);
 322 int raw_write_stdout(const void *, int);
 323
 324 # define TM_START        0
 325 # define TM_STOP         1
 326 double app_tminterval(int stop, int usertime);
 327
 328 void make_uppercase(char *string);
 329
 330 typedef struct verify_options_st {
 331     int depth;
 332     int quiet;
 333     int error;
 334     int return_error;
 335 } VERIFY_CB_ARGS;
 336
 337 extern VERIFY_CB_ARGS verify_args;
 338
 339 OSSL_PARAM *app_params_new_from_opts(STACK_OF(OPENSSL_STRING) *opts,
 340                                      const OSSL_PARAM *paramdefs);
 341 void app_params_free(OSSL_PARAM *params);
 342 int app_provider_load(OSSL_LIB_CTX *libctx, const char *provider_name);
 343 void app_providers_cleanup(void);
 344
 345 EVP_PKEY *app_keygen(EVP_PKEY_CTX *ctx, const char *alg, int bits, int verbose);
 346 EVP_PKEY *app_paramgen(EVP_PKEY_CTX *ctx, const char *alg);
 347
 348 #endif