apps/include/apps.h

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