apps.h 14 KB

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