]> git.ipfire.org Git - thirdparty/openssl.git/blame - apps/include/apps.h
Make better use of new load_cert_pass() variant of load_cert() in apps/
[thirdparty/openssl.git] / apps / include / apps.h
CommitLineData
846e33c7 1/*
33388b44 2 * Copyright 1995-2020 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
4cff10dc 13# include "e_os.h" /* struct timeval for DTLS */
07016a8a 14# include "internal/nelem.h"
8c10e1b6 15# include "internal/sockets.h" /* for openssl_fdset() */
3b061a00 16# include <assert.h>
0f113f3e 17
e306f83c 18# include <stdarg.h>
3e3c7c36 19# include <sys/types.h>
c7d5ea26
VD
20# ifndef OPENSSL_NO_POSIX_IO
21# include <sys/stat.h>
22# include <fcntl.h>
23# endif
24
568b8020 25# include <openssl/e_os2.h>
50cd4768 26# include <openssl/types.h>
0f113f3e
MC
27# include <openssl/bio.h>
28# include <openssl/x509.h>
0f113f3e
MC
29# include <openssl/conf.h>
30# include <openssl/txt_db.h>
3c27208f
RS
31# include <openssl/engine.h>
32# include <openssl/ocsp.h>
29f178bd 33# include <openssl/http.h>
1fbab1dc 34# include <signal.h>
a43ce58f
SL
35# include "apps_ui.h"
36# include "opt.h"
37# include "fmt.h"
ce506d27 38# include "platform.h"
d02b48c6 39
18295f0c
RL
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 */
538404d2 45# define _UC(c) ((unsigned char)(c))
18295f0c 46
3ee1eac2
RS
47void app_RAND_load_conf(CONF *c, const char *section);
48void app_RAND_write(void);
a31011e8 49
d02b48c6 50extern char *default_config_file;
7e1b7485
RS
51extern BIO *bio_in;
52extern BIO *bio_out;
d02b48c6 53extern BIO *bio_err;
adfc3786
MC
54extern const unsigned char tls13_aes128gcmsha256_id[];
55extern const unsigned char tls13_aes256gcmsha384_id[];
10ee7246
MC
56extern BIO_ADDR *ourpeer;
57
a60994df
RL
58BIO *dup_bio_in(int format);
59BIO *dup_bio_out(int format);
149bd5d6 60BIO *dup_bio_err(int format);
bdd58d98
RL
61BIO *bio_open_owner(const char *filename, int format, int private);
62BIO *bio_open_default(const char *filename, char mode, int format);
63BIO *bio_open_default_quiet(const char *filename, char mode, int format);
bfa470a4 64CONF *app_load_config_bio(BIO *in, const char *filename);
296f54ee
RL
65CONF *app_load_config(const char *filename);
66CONF *app_load_config_quiet(const char *filename);
67int app_load_modules(const CONF *config);
ae89578b 68CONF *app_load_config_modules(const char *configfile);
7e1b7485 69void unbuffer(FILE *fp);
e1b9840e 70void wait_for_async(SSL *s);
75dd6c1a
MC
71# if defined(OPENSSL_SYS_MSDOS)
72int has_stdin_waiting(void);
73# endif
d02b48c6 74
a0754084 75void corrupt_signature(const ASN1_STRING *signature);
dc047d31
DSH
76int set_cert_times(X509 *x, const char *startdate, const char *enddate,
77 int days);
17ebf85a 78
0f113f3e 79typedef struct args_st {
7e1b7485
RS
80 int size;
81 int argc;
82 char **argv;
0f113f3e 83} ARGS;
7bf7333d 84
229446df
RS
85/* We need both wrap and the "real" function because libcrypto uses both. */
86int wrap_password_callback(char *buf, int bufsiz, int verify, void *cb_data);
2fe5adc3 87
7e1b7485 88int chopup_args(ARGS *arg, char *buf);
954ef7ef 89int dump_cert_text(BIO *out, X509 *x);
8cc86b81 90void print_name(BIO *out, const char *title, const X509_NAME *nm,
0f113f3e 91 unsigned long lflags);
2ac6115d
RL
92void print_bignum_var(BIO *, const BIGNUM *, const char*,
93 int, unsigned char *);
7e1b7485 94void print_array(BIO *, const char *, int, const unsigned char *);
b5c4209b
DB
95int set_nameopt(const char *arg);
96unsigned long get_nameopt(void);
8ca533e3 97int set_cert_ex(unsigned long *flags, const char *arg);
a657546f 98int set_name_ex(unsigned long *flags, const char *arg);
791bd0cd
DSH
99int set_ext_copy(int *copy_type, const char *arg);
100int copy_extensions(X509 *x, X509_REQ *req, int copy_type);
6d382c74 101char *get_passwd(const char *pass, const char *desc);
cc696296 102int app_passwd(const char *arg1, const char *arg2, char **pass1, char **pass2);
7e1b7485 103int add_oid_section(CONF *conf);
9d5aca65 104X509_REQ *load_csr(const char *file, int format, const char *desc);
6d382c74
DDO
105X509 *load_cert_pass(const char *uri, int maybe_stdin,
106 const char *pass, const char *desc);
107/* the format parameter is meanwhile not needed anymore and thus ignored */
2a33470b 108#define load_cert(uri, format, desc) load_cert_pass(uri, 0, NULL, desc)
6d382c74
DDO
109X509_CRL *load_crl(const char *uri, int format, const char *desc);
110void cleanse(char *str);
111void clear_free(char *str);
112EVP_PKEY *load_key(const char *uri, int format, int maybe_stdin,
9d5aca65 113 const char *pass, ENGINE *e, const char *desc);
6d382c74 114EVP_PKEY *load_pubkey(const char *uri, int format, int maybe_stdin,
9d5aca65 115 const char *pass, ENGINE *e, const char *desc);
b3c5aadf 116int load_certs(const char *uri, STACK_OF(X509) **certs,
9d5aca65 117 const char *pass, const char *desc);
b3c5aadf 118int load_crls(const char *uri, STACK_OF(X509_CRL) **crls,
9d5aca65 119 const char *pass, const char *desc);
b3c5aadf
DDO
120int load_key_certs_crls(const char *uri, int maybe_stdin,
121 const char *pass, const char *desc,
122 EVP_PKEY **ppkey, EVP_PKEY **ppubkey,
123 X509 **pcert, STACK_OF(X509) **pcerts,
124 X509_CRL **pcrl, STACK_OF(X509_CRL) **pcrls);
6d382c74
DDO
125int load_key_cert_crl(const char *uri, int maybe_stdin,
126 const char *pass, const char *desc,
2274d22d
RL
127 EVP_PKEY **ppkey, EVP_PKEY **ppubkey,
128 X509 **pcert, X509_CRL **pcrl);
fd3397fc
RL
129X509_STORE *setup_verify(const char *CAfile, int noCAfile,
130 const char *CApath, int noCApath,
131 const char *CAstore, int noCAstore);
132__owur int ctx_set_verify_locations(SSL_CTX *ctx,
133 const char *CAfile, int noCAfile,
134 const char *CApath, int noCApath,
135 const char *CAstore, int noCAstore);
ca74c38d 136
538404d2 137# ifndef OPENSSL_NO_CT
b5369582 138
ca74c38d
RP
139/*
140 * Sets the file to load the Certificate Transparency log list from.
141 * If path is NULL, loads from the default file path.
142 * Returns 1 on success, 0 otherwise.
143 */
5da65ef2 144__owur int ctx_set_ctlog_list_file(SSL_CTX *ctx, const char *path);
dd696a55 145
538404d2 146# endif
b5369582 147
538404d2
DO
148ENGINE *setup_engine_methods(const char *id, unsigned int methods, int debug);
149# define setup_engine(e, debug) setup_engine_methods(e, (unsigned int)-1, debug)
dd1abd44 150void release_engine(ENGINE *e);
907c6c86 151
0f113f3e 152# ifndef OPENSSL_NO_OCSP
7e1b7485 153OCSP_RESPONSE *process_responder(OCSP_REQUEST *req,
0f113f3e
MC
154 const char *host, const char *path,
155 const char *port, int use_ssl,
82c49427 156 STACK_OF(CONF_VALUE) *headers,
0f113f3e
MC
157 int req_timeout);
158# endif
67c8e7f4 159
ee306a13
DSH
160/* Functions defined in ca.c and also used in ocsp.c */
161int unpack_revinfo(ASN1_TIME **prevtm, int *preason, ASN1_OBJECT **phold,
0f113f3e
MC
162 ASN1_GENERALIZEDTIME **pinvtm, const char *str);
163
164# define DB_type 0
165# define DB_exp_date 1
166# define DB_rev_date 2
167# define DB_serial 3 /* index - unique */
168# define DB_file 4
169# define DB_name 5 /* index - unique when active and not
170 * disabled */
171# define DB_NUMBER 6
172
06a79af2
F
173# define DB_TYPE_REV 'R' /* Revoked */
174# define DB_TYPE_EXP 'E' /* Expired */
175# define DB_TYPE_VAL 'V' /* Valid ; inserted with: ca ... -valid */
176# define DB_TYPE_SUSP 'S' /* Suspended */
0f113f3e
MC
177
178typedef struct db_attr_st {
179 int unique_subject;
180} DB_ATTR;
181typedef struct ca_db_st {
182 DB_ATTR attributes;
183 TXT_DB *db;
c7d5ea26
VD
184 char *dbfname;
185# ifndef OPENSSL_NO_POSIX_IO
186 struct stat dbst;
187# endif
0f113f3e 188} CA_DB;
f85b68cd 189
e306f83c 190void app_bail_out(char *fmt, ...);
68dc6824 191void* app_malloc(int sz, const char *what);
cc696296
F
192BIGNUM *load_serial(const char *serialfile, int create, ASN1_INTEGER **retai);
193int save_serial(const char *serialfile, const char *suffix, const BIGNUM *serial,
0f113f3e 194 ASN1_INTEGER **retai);
cc696296
F
195int rotate_serial(const char *serialfile, const char *new_suffix,
196 const char *old_suffix);
64674bcc 197int rand_serial(BIGNUM *b, ASN1_INTEGER *ai);
cc696296 198CA_DB *load_index(const char *dbfile, DB_ATTR *dbattr);
f85b68cd 199int index_index(CA_DB *db);
7d727231 200int save_index(const char *dbfile, const char *suffix, CA_DB *db);
0f113f3e
MC
201int rotate_index(const char *dbfile, const char *new_suffix,
202 const char *old_suffix);
f85b68cd 203void free_index(CA_DB *db);
0f113f3e
MC
204# define index_name_cmp_noconst(a, b) \
205 index_name_cmp((const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, a), \
206 (const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, b))
c869da88 207int index_name_cmp(const OPENSSL_CSTRING *a, const OPENSSL_CSTRING *b);
ff990440 208int parse_yesno(const char *str, int def);
ee306a13 209
57c05c57
DDO
210X509_NAME *parse_name(const char *str, int chtype, int multirdn,
211 const char *desc);
ecf3a1fb 212void policies_print(X509_STORE_CTX *ctx);
a9164153 213int bio_to_mem(unsigned char **out, int maxlen, BIO *in);
0c20802c 214int pkey_ctrl_string(EVP_PKEY_CTX *ctx, const char *value);
aba9bca3
RL
215int x509_ctrl_string(X509 *x, const char *value);
216int x509_req_ctrl_string(X509_REQ *x, const char *value);
7e1b7485 217int init_gen_str(EVP_PKEY_CTX **pctx,
7c9a7cf1
SL
218 const char *algname, ENGINE *e, int do_param,
219 OPENSSL_CTX *libctx, const char *propq);
7e1b7485 220int do_X509_sign(X509 *x, EVP_PKEY *pkey, const EVP_MD *md,
0f113f3e 221 STACK_OF(OPENSSL_STRING) *sigopts);
2292c8e1 222int do_X509_verify(X509 *x, EVP_PKEY *pkey, STACK_OF(OPENSSL_STRING) *vfyopts);
7e1b7485 223int do_X509_REQ_sign(X509_REQ *x, EVP_PKEY *pkey, const EVP_MD *md,
0f113f3e 224 STACK_OF(OPENSSL_STRING) *sigopts);
aba9bca3
RL
225int do_X509_REQ_verify(X509_REQ *x, EVP_PKEY *pkey,
226 STACK_OF(OPENSSL_STRING) *vfyopts);
7e1b7485 227int do_X509_CRL_sign(X509_CRL *x, EVP_PKEY *pkey, const EVP_MD *md,
0f113f3e 228 STACK_OF(OPENSSL_STRING) *sigopts);
14e35350 229
f3b7bdad 230extern char *psk_key;
14e35350 231
eee6c81a 232
817cd0d5 233unsigned char *next_protos_parse(size_t *outlen, const char *in);
71fa4513 234
a70da5b3 235void print_cert_checks(BIO *bio, X509 *x,
0f113f3e
MC
236 const char *checkhost,
237 const char *checkemail, const char *checkip);
a70da5b3 238
0090a686
DSH
239void store_setup_crl_download(X509_STORE *st);
240
29f178bd
DDO
241typedef struct app_http_tls_info_st {
242 const char *server;
243 const char *port;
244 int use_proxy;
245 long timeout;
246 SSL_CTX *ssl_ctx;
247} APP_HTTP_TLS_INFO;
248BIO *app_http_tls_cb(BIO *hbio, /* APP_HTTP_TLS_INFO */ void *arg,
249 int connect, int detail);
250# ifndef OPENSSL_NO_SOCK
251ASN1_VALUE *app_http_get_asn1(const char *url, const char *proxy,
afe554c2 252 const char *no_proxy, SSL_CTX *ssl_ctx,
29f178bd
DDO
253 const STACK_OF(CONF_VALUE) *headers,
254 long timeout, const char *expected_content_type,
255 const ASN1_ITEM *it);
256ASN1_VALUE *app_http_post_asn1(const char *host, const char *port,
257 const char *path, const char *proxy,
afe554c2 258 const char *no_proxy, SSL_CTX *ctx,
29f178bd
DDO
259 const STACK_OF(CONF_VALUE) *headers,
260 const char *content_type,
261 ASN1_VALUE *req, const ASN1_ITEM *req_it,
262 long timeout, const ASN1_ITEM *rsp_it);
263# endif
264
0f113f3e
MC
265# define EXT_COPY_NONE 0
266# define EXT_COPY_ADD 1
267# define EXT_COPY_ALL 2
268
269# define NETSCAPE_CERT_HDR "certificate"
270
271# define APP_PASS_LEN 1024
272
ffb46830
RS
273/*
274 * IETF RFC 5280 says serial number must be <= 20 bytes. Use 159 bits
275 * so that the first bit will never be one, so that the DER encoding
276 * rules won't force a leading octet.
277 */
278# define SERIAL_RAND_BITS 159
64674bcc 279
ffa10187 280int app_isdir(const char *);
7e1b7485 281int app_access(const char *, int flag);
51e5133d
RL
282int fileno_stdin(void);
283int fileno_stdout(void);
0f113f3e
MC
284int raw_read_stdin(void *, int);
285int raw_write_stdout(const void *, int);
0a39d8f2 286
0f113f3e
MC
287# define TM_START 0
288# define TM_STOP 1
289double app_tminterval(int stop, int usertime);
ee2ffc27 290
20967afb
RS
291void make_uppercase(char *string);
292
acc00492
F
293typedef struct verify_options_st {
294 int depth;
295 int quiet;
296 int error;
297 int return_error;
298} VERIFY_CB_ARGS;
299
300extern VERIFY_CB_ARGS verify_args;
df2ee0e2 301
ae89578b
SL
302OPENSSL_CTX *app_create_libctx(void);
303OPENSSL_CTX *app_get0_libctx(void);
95214b43
SL
304OSSL_PARAM *app_params_new_from_opts(STACK_OF(OPENSSL_STRING) *opts,
305 const OSSL_PARAM *paramdefs);
306void app_params_free(OSSL_PARAM *params);
ae89578b 307int app_provider_load(OPENSSL_CTX *libctx, const char *provider_name);
f5056577 308void app_providers_cleanup(void);
95214b43 309
6725682d
SL
310OPENSSL_CTX *app_get0_libctx(void);
311const char *app_get0_propq(void);
312
ee2ffc27 313#endif