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