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