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