apps/include/apps.h

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