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