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