]>
Commit | Line | Data |
---|---|---|
846e33c7 | 1 | /* |
da1c088f | 2 | * Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved. |
a661b653 | 3 | * |
dffa7520 | 4 | * Licensed under the Apache License 2.0 (the "License"). You may not use |
846e33c7 RS |
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 | |
a661b653 | 8 | */ |
d02b48c6 | 9 | |
ae4186b0 DMSP |
10 | #ifndef OSSL_APPS_H |
11 | # define OSSL_APPS_H | |
0f113f3e | 12 | |
d5f9166b | 13 | # include "internal/e_os.h" /* struct timeval for DTLS */ |
af16097f | 14 | # include "internal/common.h" /* for HAS_PREFIX */ |
07016a8a | 15 | # include "internal/nelem.h" |
8c10e1b6 | 16 | # include "internal/sockets.h" /* for openssl_fdset() */ |
3b061a00 | 17 | # include <assert.h> |
0f113f3e | 18 | |
e306f83c | 19 | # include <stdarg.h> |
3e3c7c36 | 20 | # include <sys/types.h> |
c7d5ea26 VD |
21 | # ifndef OPENSSL_NO_POSIX_IO |
22 | # include <sys/stat.h> | |
23 | # include <fcntl.h> | |
24 | # endif | |
25 | ||
568b8020 | 26 | # include <openssl/e_os2.h> |
50cd4768 | 27 | # include <openssl/types.h> |
0f113f3e MC |
28 | # include <openssl/bio.h> |
29 | # include <openssl/x509.h> | |
0f113f3e MC |
30 | # include <openssl/conf.h> |
31 | # include <openssl/txt_db.h> | |
3c27208f RS |
32 | # include <openssl/engine.h> |
33 | # include <openssl/ocsp.h> | |
29f178bd | 34 | # include <openssl/http.h> |
1fbab1dc | 35 | # include <signal.h> |
a43ce58f SL |
36 | # include "apps_ui.h" |
37 | # include "opt.h" | |
38 | # include "fmt.h" | |
ce506d27 | 39 | # include "platform.h" |
0b27381f | 40 | # include "engine_loader.h" |
3334e039 | 41 | # include "app_libctx.h" |
d02b48c6 | 42 | |
18295f0c RL |
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 | */ | |
538404d2 | 48 | # define _UC(c) ((unsigned char)(c)) |
18295f0c | 49 | |
3ee1eac2 | 50 | void app_RAND_load_conf(CONF *c, const char *section); |
3ad60309 | 51 | int app_RAND_write(void); |
51e5df0e | 52 | int app_RAND_load(void); |
a31011e8 | 53 | |
15795943 | 54 | extern char *default_config_file; /* may be "" */ |
7e1b7485 RS |
55 | extern BIO *bio_in; |
56 | extern BIO *bio_out; | |
d02b48c6 | 57 | extern BIO *bio_err; |
adfc3786 MC |
58 | extern const unsigned char tls13_aes128gcmsha256_id[]; |
59 | extern const unsigned char tls13_aes256gcmsha384_id[]; | |
10ee7246 MC |
60 | extern BIO_ADDR *ourpeer; |
61 | ||
a60994df RL |
62 | BIO *dup_bio_in(int format); |
63 | BIO *dup_bio_out(int format); | |
149bd5d6 | 64 | BIO *dup_bio_err(int format); |
bdd58d98 RL |
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); | |
da7f81d3 | 68 | char *app_conf_try_string(const CONF *cnf, const char *group, const char *name); |
b7782687 DDO |
69 | int app_conf_try_number(const CONF *conf, const char *group, const char *name, |
70 | long *result); | |
bfa470a4 | 71 | CONF *app_load_config_bio(BIO *in, const char *filename); |
0e89b396 DDO |
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) | |
15795943 DDO |
74 | CONF *app_load_config_internal(const char *filename, int quiet); |
75 | CONF *app_load_config_verbose(const char *filename, int verbose); | |
296f54ee | 76 | int app_load_modules(const CONF *config); |
ae89578b | 77 | CONF *app_load_config_modules(const char *configfile); |
7e1b7485 | 78 | void unbuffer(FILE *fp); |
e1b9840e | 79 | void wait_for_async(SSL *s); |
75dd6c1a MC |
80 | # if defined(OPENSSL_SYS_MSDOS) |
81 | int has_stdin_waiting(void); | |
82 | # endif | |
d02b48c6 | 83 | |
a0754084 | 84 | void corrupt_signature(const ASN1_STRING *signature); |
81202237 SW |
85 | |
86 | /* Helpers for setting X509v3 certificate fields notBefore and notAfter */ | |
87 | int check_cert_time_string(const char *time, const char *desc); | |
dc047d31 | 88 | int set_cert_times(X509 *x, const char *startdate, const char *enddate, |
81202237 SW |
89 | int days, int strict_compare_times); |
90 | ||
64713cb1 CN |
91 | int set_crl_lastupdate(X509_CRL *crl, const char *lastupdate); |
92 | int set_crl_nextupdate(X509_CRL *crl, const char *nextupdate, | |
93 | long days, long hours, long secs); | |
17ebf85a | 94 | |
0f113f3e | 95 | typedef struct args_st { |
7e1b7485 RS |
96 | int size; |
97 | int argc; | |
98 | char **argv; | |
0f113f3e | 99 | } ARGS; |
7bf7333d | 100 | |
229446df RS |
101 | /* We need both wrap and the "real" function because libcrypto uses both. */ |
102 | int wrap_password_callback(char *buf, int bufsiz, int verify, void *cb_data); | |
2fe5adc3 | 103 | |
e1cd94f2 PP |
104 | /* progress callback for dsaparam, dhparam, req, genpkey, etc. */ |
105 | int progress_cb(EVP_PKEY_CTX *ctx); | |
106 | ||
7e1b7485 | 107 | int chopup_args(ARGS *arg, char *buf); |
32f7be2a | 108 | void dump_cert_text(BIO *out, X509 *x); |
46a11faf | 109 | void print_name(BIO *out, const char *title, const X509_NAME *nm); |
0e89b396 | 110 | void print_bignum_var(BIO *, const BIGNUM *, const char *, |
2ac6115d | 111 | int, unsigned char *); |
7e1b7485 | 112 | void print_array(BIO *, const char *, int, const unsigned char *); |
b5c4209b DB |
113 | int set_nameopt(const char *arg); |
114 | unsigned long get_nameopt(void); | |
8c5bff22 | 115 | int set_dateopt(unsigned long *dateopt, const char *arg); |
8ca533e3 | 116 | int set_cert_ex(unsigned long *flags, const char *arg); |
a657546f | 117 | int set_name_ex(unsigned long *flags, const char *arg); |
791bd0cd DSH |
118 | int set_ext_copy(int *copy_type, const char *arg); |
119 | int copy_extensions(X509 *x, X509_REQ *req, int copy_type); | |
6d382c74 | 120 | char *get_passwd(const char *pass, const char *desc); |
cc696296 | 121 | int app_passwd(const char *arg1, const char *arg2, char **pass1, char **pass2); |
7e1b7485 | 122 | int add_oid_section(CONF *conf); |
9d5aca65 | 123 | X509_REQ *load_csr(const char *file, int format, const char *desc); |
a75f707f TZ |
124 | X509_REQ *load_csr_autofmt(const char *infile, int format, |
125 | STACK_OF(OPENSSL_STRING) *vfyopts, const char *desc); | |
d382e796 | 126 | X509 *load_cert_pass(const char *uri, int format, int maybe_stdin, |
6d382c74 | 127 | const char *pass, const char *desc); |
0e89b396 | 128 | # define load_cert(uri, format, desc) load_cert_pass(uri, format, 1, NULL, desc) |
d382e796 TM |
129 | X509_CRL *load_crl(const char *uri, int format, int maybe_stdin, |
130 | const char *desc); | |
6d382c74 DDO |
131 | void cleanse(char *str); |
132 | void clear_free(char *str); | |
133 | EVP_PKEY *load_key(const char *uri, int format, int maybe_stdin, | |
9d5aca65 | 134 | const char *pass, ENGINE *e, const char *desc); |
0e89b396 | 135 | /* first try reading public key, on failure resort to loading private key */ |
6d382c74 | 136 | EVP_PKEY *load_pubkey(const char *uri, int format, int maybe_stdin, |
9d5aca65 | 137 | const char *pass, ENGINE *e, const char *desc); |
d382e796 TM |
138 | EVP_PKEY *load_keyparams(const char *uri, int format, int maybe_stdin, |
139 | const char *keytype, const char *desc); | |
ef044913 SL |
140 | EVP_PKEY *load_keyparams_suppress(const char *uri, int format, int maybe_stdin, |
141 | const char *keytype, const char *desc, | |
142 | int suppress_decode_errors); | |
f62846b7 DDO |
143 | char *next_item(char *opt); /* in list separated by comma and/or space */ |
144 | int load_cert_certs(const char *uri, | |
145 | X509 **pcert, STACK_OF(X509) **pcerts, | |
146 | int exclude_http, const char *pass, const char *desc, | |
147 | X509_VERIFY_PARAM *vpm); | |
148 | STACK_OF(X509) *load_certs_multifile(char *files, const char *pass, | |
149 | const char *desc, X509_VERIFY_PARAM *vpm); | |
150 | X509_STORE *load_certstore(char *input, const char *pass, const char *desc, | |
151 | X509_VERIFY_PARAM *vpm); | |
ea51096e | 152 | int load_certs(const char *uri, int maybe_stdin, STACK_OF(X509) **certs, |
9d5aca65 | 153 | const char *pass, const char *desc); |
b3c5aadf | 154 | int load_crls(const char *uri, STACK_OF(X509_CRL) **crls, |
9d5aca65 | 155 | const char *pass, const char *desc); |
d382e796 | 156 | int load_key_certs_crls(const char *uri, int format, int maybe_stdin, |
0e89b396 | 157 | const char *pass, const char *desc, int quiet, |
b3c5aadf | 158 | EVP_PKEY **ppkey, EVP_PKEY **ppubkey, |
b78c777e | 159 | EVP_PKEY **pparams, |
b3c5aadf DDO |
160 | X509 **pcert, STACK_OF(X509) **pcerts, |
161 | X509_CRL **pcrl, STACK_OF(X509_CRL) **pcrls); | |
fd3397fc RL |
162 | X509_STORE *setup_verify(const char *CAfile, int noCAfile, |
163 | const char *CApath, int noCApath, | |
164 | const char *CAstore, int noCAstore); | |
165 | __owur int ctx_set_verify_locations(SSL_CTX *ctx, | |
166 | const char *CAfile, int noCAfile, | |
167 | const char *CApath, int noCApath, | |
168 | const char *CAstore, int noCAstore); | |
ca74c38d | 169 | |
538404d2 | 170 | # ifndef OPENSSL_NO_CT |
b5369582 | 171 | |
ca74c38d RP |
172 | /* |
173 | * Sets the file to load the Certificate Transparency log list from. | |
174 | * If path is NULL, loads from the default file path. | |
175 | * Returns 1 on success, 0 otherwise. | |
176 | */ | |
5da65ef2 | 177 | __owur int ctx_set_ctlog_list_file(SSL_CTX *ctx, const char *path); |
dd696a55 | 178 | |
538404d2 | 179 | # endif |
b5369582 | 180 | |
538404d2 DO |
181 | ENGINE *setup_engine_methods(const char *id, unsigned int methods, int debug); |
182 | # define setup_engine(e, debug) setup_engine_methods(e, (unsigned int)-1, debug) | |
dd1abd44 | 183 | void release_engine(ENGINE *e); |
6514dee7 RL |
184 | int init_engine(ENGINE *e); |
185 | int finish_engine(ENGINE *e); | |
f91d003a | 186 | char *make_engine_uri(ENGINE *e, const char *key_id, const char *desc); |
907c6c86 | 187 | |
0f386f2e | 188 | int get_legacy_pkey_id(OSSL_LIB_CTX *libctx, const char *algname, ENGINE *e); |
a61fba5d DB |
189 | const EVP_MD *get_digest_from_engine(const char *name); |
190 | const EVP_CIPHER *get_cipher_from_engine(const char *name); | |
0f386f2e | 191 | |
0f113f3e | 192 | # ifndef OPENSSL_NO_OCSP |
88d96983 DDO |
193 | OCSP_RESPONSE *process_responder(OCSP_REQUEST *req, const char *host, |
194 | const char *port, const char *path, | |
195 | const char *proxy, const char *no_proxy, | |
196 | int use_ssl, STACK_OF(CONF_VALUE) *headers, | |
0f113f3e MC |
197 | int req_timeout); |
198 | # endif | |
67c8e7f4 | 199 | |
ee306a13 DSH |
200 | /* Functions defined in ca.c and also used in ocsp.c */ |
201 | int unpack_revinfo(ASN1_TIME **prevtm, int *preason, ASN1_OBJECT **phold, | |
0f113f3e MC |
202 | ASN1_GENERALIZEDTIME **pinvtm, const char *str); |
203 | ||
204 | # define DB_type 0 | |
205 | # define DB_exp_date 1 | |
206 | # define DB_rev_date 2 | |
0e89b396 | 207 | # define DB_serial 3 /* index - unique */ |
0f113f3e | 208 | # define DB_file 4 |
0e89b396 | 209 | # define DB_name 5 /* index - unique when active and not disabled */ |
0f113f3e MC |
210 | # define DB_NUMBER 6 |
211 | ||
06a79af2 F |
212 | # define DB_TYPE_REV 'R' /* Revoked */ |
213 | # define DB_TYPE_EXP 'E' /* Expired */ | |
214 | # define DB_TYPE_VAL 'V' /* Valid ; inserted with: ca ... -valid */ | |
215 | # define DB_TYPE_SUSP 'S' /* Suspended */ | |
0f113f3e MC |
216 | |
217 | typedef struct db_attr_st { | |
218 | int unique_subject; | |
219 | } DB_ATTR; | |
220 | typedef struct ca_db_st { | |
221 | DB_ATTR attributes; | |
222 | TXT_DB *db; | |
c7d5ea26 VD |
223 | char *dbfname; |
224 | # ifndef OPENSSL_NO_POSIX_IO | |
225 | struct stat dbst; | |
226 | # endif | |
0f113f3e | 227 | } CA_DB; |
f85b68cd | 228 | |
065121ff AF |
229 | extern int do_updatedb(CA_DB *db, time_t *now); |
230 | ||
e306f83c | 231 | void app_bail_out(char *fmt, ...); |
b1c908f4 | 232 | void *app_malloc(size_t sz, const char *what); |
ec8a3409 DDO |
233 | |
234 | /* load_serial, save_serial, and rotate_serial are also used for CRL numbers */ | |
235 | BIGNUM *load_serial(const char *serialfile, int *exists, int create, | |
236 | ASN1_INTEGER **retai); | |
237 | int save_serial(const char *serialfile, const char *suffix, | |
238 | const BIGNUM *serial, ASN1_INTEGER **retai); | |
cc696296 F |
239 | int rotate_serial(const char *serialfile, const char *new_suffix, |
240 | const char *old_suffix); | |
64674bcc | 241 | int rand_serial(BIGNUM *b, ASN1_INTEGER *ai); |
ec8a3409 | 242 | |
cc696296 | 243 | CA_DB *load_index(const char *dbfile, DB_ATTR *dbattr); |
f85b68cd | 244 | int index_index(CA_DB *db); |
7d727231 | 245 | int save_index(const char *dbfile, const char *suffix, CA_DB *db); |
0f113f3e MC |
246 | int rotate_index(const char *dbfile, const char *new_suffix, |
247 | const char *old_suffix); | |
f85b68cd | 248 | void free_index(CA_DB *db); |
0f113f3e | 249 | # define index_name_cmp_noconst(a, b) \ |
0e89b396 DDO |
250 | index_name_cmp((const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, a), \ |
251 | (const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, b)) | |
c869da88 | 252 | int index_name_cmp(const OPENSSL_CSTRING *a, const OPENSSL_CSTRING *b); |
ff990440 | 253 | int parse_yesno(const char *str, int def); |
ee306a13 | 254 | |
57c05c57 DDO |
255 | X509_NAME *parse_name(const char *str, int chtype, int multirdn, |
256 | const char *desc); | |
ecf3a1fb | 257 | void policies_print(X509_STORE_CTX *ctx); |
a9164153 | 258 | int bio_to_mem(unsigned char **out, int maxlen, BIO *in); |
0c20802c | 259 | int pkey_ctrl_string(EVP_PKEY_CTX *ctx, const char *value); |
aba9bca3 RL |
260 | int x509_ctrl_string(X509 *x, const char *value); |
261 | int x509_req_ctrl_string(X509_REQ *x, const char *value); | |
7e1b7485 | 262 | int init_gen_str(EVP_PKEY_CTX **pctx, |
7c9a7cf1 | 263 | const char *algname, ENGINE *e, int do_param, |
b4250010 | 264 | OSSL_LIB_CTX *libctx, const char *propq); |
adbd77f6 | 265 | int cert_matches_key(const X509 *cert, const EVP_PKEY *pkey); |
342e3652 | 266 | int do_X509_sign(X509 *x, int force_v1, EVP_PKEY *pkey, const char *md, |
ec2bfb7d | 267 | STACK_OF(OPENSSL_STRING) *sigopts, X509V3_CTX *ext_ctx); |
2292c8e1 | 268 | int do_X509_verify(X509 *x, EVP_PKEY *pkey, STACK_OF(OPENSSL_STRING) *vfyopts); |
91034b68 | 269 | int do_X509_REQ_sign(X509_REQ *x, EVP_PKEY *pkey, const char *md, |
0f113f3e | 270 | STACK_OF(OPENSSL_STRING) *sigopts); |
aba9bca3 RL |
271 | int do_X509_REQ_verify(X509_REQ *x, EVP_PKEY *pkey, |
272 | STACK_OF(OPENSSL_STRING) *vfyopts); | |
91034b68 | 273 | int do_X509_CRL_sign(X509_CRL *x, EVP_PKEY *pkey, const char *md, |
0f113f3e | 274 | STACK_OF(OPENSSL_STRING) *sigopts); |
14e35350 | 275 | |
f3b7bdad | 276 | extern char *psk_key; |
14e35350 | 277 | |
817cd0d5 | 278 | unsigned char *next_protos_parse(size_t *outlen, const char *in); |
71fa4513 | 279 | |
9567fd38 | 280 | int check_cert_attributes(BIO *bio, X509 *x, |
0e89b396 DDO |
281 | const char *checkhost, const char *checkemail, |
282 | const char *checkip, int print); | |
a70da5b3 | 283 | |
0090a686 DSH |
284 | void store_setup_crl_download(X509_STORE *st); |
285 | ||
29f178bd DDO |
286 | typedef struct app_http_tls_info_st { |
287 | const char *server; | |
288 | const char *port; | |
289 | int use_proxy; | |
290 | long timeout; | |
291 | SSL_CTX *ssl_ctx; | |
292 | } APP_HTTP_TLS_INFO; | |
293 | BIO *app_http_tls_cb(BIO *hbio, /* APP_HTTP_TLS_INFO */ void *arg, | |
294 | int connect, int detail); | |
ef203432 | 295 | void APP_HTTP_TLS_INFO_free(APP_HTTP_TLS_INFO *info); |
29f178bd DDO |
296 | # ifndef OPENSSL_NO_SOCK |
297 | ASN1_VALUE *app_http_get_asn1(const char *url, const char *proxy, | |
afe554c2 | 298 | const char *no_proxy, SSL_CTX *ssl_ctx, |
29f178bd DDO |
299 | const STACK_OF(CONF_VALUE) *headers, |
300 | long timeout, const char *expected_content_type, | |
301 | const ASN1_ITEM *it); | |
302 | ASN1_VALUE *app_http_post_asn1(const char *host, const char *port, | |
303 | const char *path, const char *proxy, | |
afe554c2 | 304 | const char *no_proxy, SSL_CTX *ctx, |
29f178bd DDO |
305 | const STACK_OF(CONF_VALUE) *headers, |
306 | const char *content_type, | |
307 | ASN1_VALUE *req, const ASN1_ITEM *req_it, | |
82990287 | 308 | const char *expected_content_type, |
29f178bd DDO |
309 | long timeout, const ASN1_ITEM *rsp_it); |
310 | # endif | |
311 | ||
0f113f3e MC |
312 | # define EXT_COPY_NONE 0 |
313 | # define EXT_COPY_ADD 1 | |
314 | # define EXT_COPY_ALL 2 | |
315 | ||
0e89b396 | 316 | # define NETSCAPE_CERT_HDR "certificate" |
0f113f3e | 317 | |
0e89b396 | 318 | # define APP_PASS_LEN 1024 |
0f113f3e | 319 | |
ffb46830 RS |
320 | /* |
321 | * IETF RFC 5280 says serial number must be <= 20 bytes. Use 159 bits | |
322 | * so that the first bit will never be one, so that the DER encoding | |
323 | * rules won't force a leading octet. | |
324 | */ | |
0e89b396 | 325 | # define SERIAL_RAND_BITS 159 |
64674bcc | 326 | |
ffa10187 | 327 | int app_isdir(const char *); |
7e1b7485 | 328 | int app_access(const char *, int flag); |
51e5133d RL |
329 | int fileno_stdin(void); |
330 | int fileno_stdout(void); | |
0f113f3e MC |
331 | int raw_read_stdin(void *, int); |
332 | int raw_write_stdout(const void *, int); | |
0a39d8f2 | 333 | |
0f113f3e MC |
334 | # define TM_START 0 |
335 | # define TM_STOP 1 | |
336 | double app_tminterval(int stop, int usertime); | |
ee2ffc27 | 337 | |
20967afb RS |
338 | void make_uppercase(char *string); |
339 | ||
acc00492 F |
340 | typedef struct verify_options_st { |
341 | int depth; | |
342 | int quiet; | |
343 | int error; | |
344 | int return_error; | |
345 | } VERIFY_CB_ARGS; | |
346 | ||
347 | extern VERIFY_CB_ARGS verify_args; | |
df2ee0e2 | 348 | |
95214b43 SL |
349 | OSSL_PARAM *app_params_new_from_opts(STACK_OF(OPENSSL_STRING) *opts, |
350 | const OSSL_PARAM *paramdefs); | |
351 | void app_params_free(OSSL_PARAM *params); | |
b4250010 | 352 | int app_provider_load(OSSL_LIB_CTX *libctx, const char *provider_name); |
f5056577 | 353 | void app_providers_cleanup(void); |
95214b43 | 354 | |
a7e4ca5b DDO |
355 | EVP_PKEY *app_keygen(EVP_PKEY_CTX *ctx, const char *alg, int bits, int verbose); |
356 | EVP_PKEY *app_paramgen(EVP_PKEY_CTX *ctx, const char *alg); | |
357 | ||
ee2ffc27 | 358 | #endif |